From 6cf82e835d6084e0d33f4716780c59d304410ae9 Mon Sep 17 00:00:00 2001 From: awssdkgo Date: Mon, 24 Oct 2022 19:09:56 +0000 Subject: [PATCH] Release v1.44.122 (2022-10-24) === ### Service Client Updates * `service/acm-pca`: Updates service API and documentation * `service/batch`: Updates service API and documentation * This release adds support for AWS Batch on Amazon EKS. * `service/datasync`: Updates service API and documentation * `service/sagemaker`: Updates service API, documentation, and paginators * SageMaker Inference Recommender now supports a new API ListInferenceRecommendationJobSteps to return the details of all the benchmark we create for an inference recommendation job. --- CHANGELOG.md | 11 + aws/endpoints/defaults.go | 9 + aws/version.go | 2 +- models/apis/acm-pca/2017-08-22/api-2.json | 13 +- models/apis/acm-pca/2017-08-22/docs-2.json | 17 +- .../2017-08-22/endpoint-rule-set-1.json | 340 ++ .../acm-pca/2017-08-22/endpoint-tests-1.json | 1543 ++++++++ models/apis/batch/2016-08-10/api-2.json | 264 +- models/apis/batch/2016-08-10/docs-2.json | 646 +++- .../batch/2016-08-10/endpoint-rule-set-1.json | 365 ++ .../batch/2016-08-10/endpoint-tests-1.json | 1395 ++++++++ models/apis/datasync/2018-11-09/api-2.json | 16 +- models/apis/datasync/2018-11-09/docs-2.json | 53 +- .../2018-11-09/endpoint-rule-set-1.json | 315 ++ .../datasync/2018-11-09/endpoint-tests-1.json | 1543 ++++++++ models/apis/sagemaker/2017-07-24/api-2.json | 63 +- models/apis/sagemaker/2017-07-24/docs-2.json | 58 +- .../sagemaker/2017-07-24/paginators-1.json | 6 + models/endpoints/endpoints.json | 7 + service/acmpca/api.go | 52 +- service/acmpca/doc.go | 8 +- service/batch/api.go | 3149 +++++++++++++---- service/batch/doc.go | 15 +- service/batch/errors.go | 7 +- service/datasync/api.go | 149 +- service/datasync/doc.go | 9 +- service/sagemaker/api.go | 414 +++ service/sagemaker/sagemakeriface/interface.go | 7 + 28 files changed, 9494 insertions(+), 982 deletions(-) create mode 100644 models/apis/acm-pca/2017-08-22/endpoint-rule-set-1.json create mode 100644 models/apis/acm-pca/2017-08-22/endpoint-tests-1.json create mode 100644 models/apis/batch/2016-08-10/endpoint-rule-set-1.json create mode 100644 models/apis/batch/2016-08-10/endpoint-tests-1.json create mode 100644 models/apis/datasync/2018-11-09/endpoint-rule-set-1.json create mode 100644 models/apis/datasync/2018-11-09/endpoint-tests-1.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b2ac69916..179cff1e95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,14 @@ +Release v1.44.122 (2022-10-24) +=== + +### Service Client Updates +* `service/acm-pca`: Updates service API and documentation +* `service/batch`: Updates service API and documentation + * This release adds support for AWS Batch on Amazon EKS. +* `service/datasync`: Updates service API and documentation +* `service/sagemaker`: Updates service API, documentation, and paginators + * SageMaker Inference Recommender now supports a new API ListInferenceRecommendationJobSteps to return the details of all the benchmark we create for an inference recommendation job. + Release v1.44.121 (2022-10-21) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 4ceabfe96a..3a230db4f5 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -13722,6 +13722,15 @@ var awsPartition = partition{ }, Deprecated: boxedTrue, }, + endpointKey{ + Region: "ap-south-2-fips", + }: endpoint{ + Hostname: "kms-fips.ap-south-2.amazonaws.com", + CredentialScope: credentialScope{ + Region: "ap-south-2", + }, + Deprecated: boxedTrue, + }, endpointKey{ Region: "ap-southeast-1", }: endpoint{}, diff --git a/aws/version.go b/aws/version.go index a795ed615f..bc123f30cd 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.121" +const SDKVersion = "1.44.122" diff --git a/models/apis/acm-pca/2017-08-22/api-2.json b/models/apis/acm-pca/2017-08-22/api-2.json index be7741a6d1..9283c2e033 100644 --- a/models/apis/acm-pca/2017-08-22/api-2.json +++ b/models/apis/acm-pca/2017-08-22/api-2.json @@ -514,7 +514,8 @@ "CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"}, "RevocationConfiguration":{"shape":"RevocationConfiguration"}, "RestorableUntil":{"shape":"TStamp"}, - "KeyStorageSecurityStandard":{"shape":"KeyStorageSecurityStandard"} + "KeyStorageSecurityStandard":{"shape":"KeyStorageSecurityStandard"}, + "UsageMode":{"shape":"CertificateAuthorityUsageMode"} } }, "CertificateAuthorityConfiguration":{ @@ -550,6 +551,13 @@ "SUBORDINATE" ] }, + "CertificateAuthorityUsageMode":{ + "type":"string", + "enum":[ + "GENERAL_PURPOSE", + "SHORT_LIVED_CERTIFICATE" + ] + }, "CertificateBody":{"type":"string"}, "CertificateBodyBlob":{ "type":"blob", @@ -620,7 +628,8 @@ "CertificateAuthorityType":{"shape":"CertificateAuthorityType"}, "IdempotencyToken":{"shape":"IdempotencyToken"}, "KeyStorageSecurityStandard":{"shape":"KeyStorageSecurityStandard"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "UsageMode":{"shape":"CertificateAuthorityUsageMode"} } }, "CreateCertificateAuthorityResponse":{ diff --git a/models/apis/acm-pca/2017-08-22/docs-2.json b/models/apis/acm-pca/2017-08-22/docs-2.json index 31507d8fba..16ff6600aa 100644 --- a/models/apis/acm-pca/2017-08-22/docs-2.json +++ b/models/apis/acm-pca/2017-08-22/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

This is the Certificate Manager Private Certificate Authority (PCA) API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each ACM Private CA API operation has a quota that determines the number of times the operation can be called per second. ACM Private CA throttles API requests at different rates depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, ACM Private CA returns a ThrottlingException error. ACM Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

", + "service": "

This is the Private Certificate Authority (PCA) API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each ACM Private CA API operation has a quota that determines the number of times the operation can be called per second. ACM Private CA throttles API requests at different rates depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, ACM Private CA returns a ThrottlingException error. ACM Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

", "operations": { "CreateCertificateAuthority": "

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

", "CreateCertificateAuthorityAuditReport": "

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

You can generate a maximum of one report every 30 minutes.

", @@ -210,6 +210,13 @@ "CreateCertificateAuthorityRequest$CertificateAuthorityType": "

The type of the certificate authority.

" } }, + "CertificateAuthorityUsageMode": { + "base": null, + "refs": { + "CertificateAuthority$UsageMode": "

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

", + "CreateCertificateAuthorityRequest$UsageMode": "

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

" + } + }, "CertificateBody": { "base": null, "refs": { @@ -284,7 +291,7 @@ } }, "CrlConfiguration": { - "base": "

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

For more information, see Planning a certificate revocation list (CRL) in the Certificate Manager Private Certificate Authority (PCA) User Guide

", + "base": "

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

For more information, see Planning a certificate revocation list (CRL) in the Private Certificate Authority (PCA) User Guide

", "refs": { "RevocationConfiguration$CrlConfiguration": "

Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.

" } @@ -735,7 +742,7 @@ } }, "RevocationConfiguration": { - "base": "

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Certificate Manager Private Certificate Authority (PCA) User Guide.

", + "base": "

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Private Certificate Authority (PCA) User Guide.

", "refs": { "CertificateAuthority$RevocationConfiguration": "

Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

", "CreateCertificateAuthorityRequest$RevocationConfiguration": "

Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled. For more information, see the OcspConfiguration and CrlConfiguration types.

", @@ -832,7 +839,7 @@ "CrlConfiguration$CustomCname": "

Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.

", "GeneralName$DnsName": "

Represents GeneralName as a DNS name.

", "GeneralName$UniformResourceIdentifier": "

Represents GeneralName as a URI.

", - "OcspConfiguration$OcspCustomCname": "

By default, ACM Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

Note: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".

For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Certificate Manager Private Certificate Authority (PCA) User Guide.

" + "OcspConfiguration$OcspCustomCname": "

By default, ACM Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

Note: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".

For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Private Certificate Authority (PCA) User Guide.

" } }, "String256": { @@ -944,7 +951,7 @@ } }, "Validity": { - "base": "

Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

ACM Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.

", + "base": "

Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

ACM Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.

", "refs": { "IssueCertificateRequest$Validity": "

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.

", "IssueCertificateRequest$ValidityNotBefore": "

Information describing the start of the validity period of the certificate. This parameter sets the “Not Before\" date for the certificate.

By default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

" diff --git a/models/apis/acm-pca/2017-08-22/endpoint-rule-set-1.json b/models/apis/acm-pca/2017-08-22/endpoint-rule-set-1.json new file mode 100644 index 0000000000..5ab3c3da43 --- /dev/null +++ b/models/apis/acm-pca/2017-08-22/endpoint-rule-set-1.json @@ -0,0 +1,340 @@ +{ + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://acm-pca-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://acm-pca.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://acm-pca-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://acm-pca.{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://acm-pca.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/acm-pca/2017-08-22/endpoint-tests-1.json b/models/apis/acm-pca/2017-08-22/endpoint-tests-1.json new file mode 100644 index 0000000000..8c26a506cc --- /dev/null +++ b/models/apis/acm-pca/2017-08-22/endpoint-tests-1.json @@ -0,0 +1,1543 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://acm-pca.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "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": { + "UseFIPS": true, + "Region": "us-east-1", + "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": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/batch/2016-08-10/api-2.json b/models/apis/batch/2016-08-10/api-2.json index 374c18d90e..a798e564db 100644 --- a/models/apis/batch/2016-08-10/api-2.json +++ b/models/apis/batch/2016-08-10/api-2.json @@ -482,7 +482,10 @@ "statusReason":{"shape":"String"}, "computeResources":{"shape":"ComputeResource"}, "serviceRole":{"shape":"String"}, - "updatePolicy":{"shape":"UpdatePolicy"} + "updatePolicy":{"shape":"UpdatePolicy"}, + "eksConfiguration":{"shape":"EksConfiguration"}, + "containerOrchestrationType":{"shape":"OrchestrationType"}, + "uuid":{"shape":"String"} } }, "ComputeEnvironmentDetailList":{ @@ -660,7 +663,8 @@ "unmanagedvCpus":{"shape":"Integer"}, "computeResources":{"shape":"ComputeResource"}, "serviceRole":{"shape":"String"}, - "tags":{"shape":"TagrisTagsMap"} + "tags":{"shape":"TagrisTagsMap"}, + "eksConfiguration":{"shape":"EksConfiguration"} } }, "CreateComputeEnvironmentResponse":{ @@ -900,13 +904,236 @@ "required":["imageType"], "members":{ "imageType":{"shape":"ImageType"}, - "imageIdOverride":{"shape":"ImageIdOverride"} + "imageIdOverride":{"shape":"ImageIdOverride"}, + "imageKubernetesVersion":{"shape":"KubernetesVersion"} } }, "Ec2ConfigurationList":{ "type":"list", "member":{"shape":"Ec2Configuration"} }, + "EksAttemptContainerDetail":{ + "type":"structure", + "members":{ + "exitCode":{"shape":"Integer"}, + "reason":{"shape":"String"} + } + }, + "EksAttemptContainerDetails":{ + "type":"list", + "member":{"shape":"EksAttemptContainerDetail"} + }, + "EksAttemptDetail":{ + "type":"structure", + "members":{ + "containers":{"shape":"EksAttemptContainerDetails"}, + "podName":{"shape":"String"}, + "nodeName":{"shape":"String"}, + "startedAt":{"shape":"Long"}, + "stoppedAt":{"shape":"Long"}, + "statusReason":{"shape":"String"} + } + }, + "EksAttemptDetails":{ + "type":"list", + "member":{"shape":"EksAttemptDetail"} + }, + "EksConfiguration":{ + "type":"structure", + "required":[ + "eksClusterArn", + "kubernetesNamespace" + ], + "members":{ + "eksClusterArn":{"shape":"String"}, + "kubernetesNamespace":{"shape":"String"} + } + }, + "EksContainer":{ + "type":"structure", + "required":["image"], + "members":{ + "name":{"shape":"String"}, + "image":{"shape":"String"}, + "imagePullPolicy":{"shape":"String"}, + "command":{"shape":"StringList"}, + "args":{"shape":"StringList"}, + "env":{"shape":"EksContainerEnvironmentVariables"}, + "resources":{"shape":"EksContainerResourceRequirements"}, + "volumeMounts":{"shape":"EksContainerVolumeMounts"}, + "securityContext":{"shape":"EksContainerSecurityContext"} + } + }, + "EksContainerDetail":{ + "type":"structure", + "members":{ + "name":{"shape":"String"}, + "image":{"shape":"String"}, + "imagePullPolicy":{"shape":"String"}, + "command":{"shape":"StringList"}, + "args":{"shape":"StringList"}, + "env":{"shape":"EksContainerEnvironmentVariables"}, + "resources":{"shape":"EksContainerResourceRequirements"}, + "exitCode":{"shape":"Integer"}, + "reason":{"shape":"String"}, + "volumeMounts":{"shape":"EksContainerVolumeMounts"}, + "securityContext":{"shape":"EksContainerSecurityContext"} + } + }, + "EksContainerDetails":{ + "type":"list", + "member":{"shape":"EksContainerDetail"} + }, + "EksContainerEnvironmentVariable":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"String"}, + "value":{"shape":"String"} + } + }, + "EksContainerEnvironmentVariables":{ + "type":"list", + "member":{"shape":"EksContainerEnvironmentVariable"} + }, + "EksContainerOverride":{ + "type":"structure", + "members":{ + "image":{"shape":"String"}, + "command":{"shape":"StringList"}, + "args":{"shape":"StringList"}, + "env":{"shape":"EksContainerEnvironmentVariables"}, + "resources":{"shape":"EksContainerResourceRequirements"} + } + }, + "EksContainerOverrideList":{ + "type":"list", + "member":{"shape":"EksContainerOverride"} + }, + "EksContainerResourceRequirements":{ + "type":"structure", + "members":{ + "limits":{"shape":"EksLimits"}, + "requests":{"shape":"EksRequests"} + } + }, + "EksContainerSecurityContext":{ + "type":"structure", + "members":{ + "runAsUser":{"shape":"Long"}, + "runAsGroup":{"shape":"Long"}, + "privileged":{"shape":"Boolean"}, + "readOnlyRootFilesystem":{"shape":"Boolean"}, + "runAsNonRoot":{"shape":"Boolean"} + } + }, + "EksContainerVolumeMount":{ + "type":"structure", + "members":{ + "name":{"shape":"String"}, + "mountPath":{"shape":"String"}, + "readOnly":{"shape":"Boolean"} + } + }, + "EksContainerVolumeMounts":{ + "type":"list", + "member":{"shape":"EksContainerVolumeMount"} + }, + "EksContainers":{ + "type":"list", + "member":{"shape":"EksContainer"} + }, + "EksEmptyDir":{ + "type":"structure", + "members":{ + "medium":{"shape":"String"}, + "sizeLimit":{"shape":"Quantity"} + } + }, + "EksHostPath":{ + "type":"structure", + "members":{ + "path":{"shape":"String"} + } + }, + "EksLimits":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Quantity"} + }, + "EksPodProperties":{ + "type":"structure", + "members":{ + "serviceAccountName":{"shape":"String"}, + "hostNetwork":{"shape":"Boolean"}, + "dnsPolicy":{"shape":"String"}, + "containers":{"shape":"EksContainers"}, + "volumes":{"shape":"EksVolumes"} + } + }, + "EksPodPropertiesDetail":{ + "type":"structure", + "members":{ + "serviceAccountName":{"shape":"String"}, + "hostNetwork":{"shape":"Boolean"}, + "dnsPolicy":{"shape":"String"}, + "containers":{"shape":"EksContainerDetails"}, + "volumes":{"shape":"EksVolumes"}, + "podName":{"shape":"String"}, + "nodeName":{"shape":"String"} + } + }, + "EksPodPropertiesOverride":{ + "type":"structure", + "members":{ + "containers":{"shape":"EksContainerOverrideList"} + } + }, + "EksProperties":{ + "type":"structure", + "members":{ + "podProperties":{"shape":"EksPodProperties"} + } + }, + "EksPropertiesDetail":{ + "type":"structure", + "members":{ + "podProperties":{"shape":"EksPodPropertiesDetail"} + } + }, + "EksPropertiesOverride":{ + "type":"structure", + "members":{ + "podProperties":{"shape":"EksPodPropertiesOverride"} + } + }, + "EksRequests":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Quantity"} + }, + "EksSecret":{ + "type":"structure", + "required":["secretName"], + "members":{ + "secretName":{"shape":"String"}, + "optional":{"shape":"Boolean"} + } + }, + "EksVolume":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"String"}, + "hostPath":{"shape":"EksHostPath"}, + "emptyDir":{"shape":"EksEmptyDir"}, + "secret":{"shape":"EksSecret"} + } + }, + "EksVolumes":{ + "type":"list", + "member":{"shape":"EksVolume"} + }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"KeyValuePair"} @@ -997,7 +1224,9 @@ "nodeProperties":{"shape":"NodeProperties"}, "tags":{"shape":"TagrisTagsMap"}, "propagateTags":{"shape":"Boolean"}, - "platformCapabilities":{"shape":"PlatformCapabilityList"} + "platformCapabilities":{"shape":"PlatformCapabilityList"}, + "eksProperties":{"shape":"EksProperties"}, + "containerOrchestrationType":{"shape":"OrchestrationType"} } }, "JobDefinitionList":{ @@ -1056,7 +1285,9 @@ "timeout":{"shape":"JobTimeout"}, "tags":{"shape":"TagrisTagsMap"}, "propagateTags":{"shape":"Boolean"}, - "platformCapabilities":{"shape":"PlatformCapabilityList"} + "platformCapabilities":{"shape":"PlatformCapabilityList"}, + "eksProperties":{"shape":"EksPropertiesDetail"}, + "eksAttempts":{"shape":"EksAttemptDetails"} } }, "JobDetailList":{ @@ -1150,6 +1381,11 @@ "values":{"shape":"StringList"} } }, + "KubernetesVersion":{ + "type":"string", + "max":256, + "min":1 + }, "LaunchTemplateSpecification":{ "type":"structure", "members":{ @@ -1340,6 +1576,13 @@ "container":{"shape":"ContainerProperties"} } }, + "OrchestrationType":{ + "type":"string", + "enum":[ + "ECS", + "EKS" + ] + }, "ParametersMap":{ "type":"map", "key":{"shape":"String"}, @@ -1356,6 +1599,11 @@ "type":"list", "member":{"shape":"PlatformCapability"} }, + "Quantity":{ + "type":"string", + "max":256, + "min":1 + }, "RegisterJobDefinitionRequest":{ "type":"structure", "required":[ @@ -1373,7 +1621,8 @@ "propagateTags":{"shape":"Boolean"}, "timeout":{"shape":"JobTimeout"}, "tags":{"shape":"TagrisTagsMap"}, - "platformCapabilities":{"shape":"PlatformCapabilityList"} + "platformCapabilities":{"shape":"PlatformCapabilityList"}, + "eksProperties":{"shape":"EksProperties"} } }, "RegisterJobDefinitionResponse":{ @@ -1516,7 +1765,8 @@ "retryStrategy":{"shape":"RetryStrategy"}, "propagateTags":{"shape":"Boolean"}, "timeout":{"shape":"JobTimeout"}, - "tags":{"shape":"TagrisTagsMap"} + "tags":{"shape":"TagrisTagsMap"}, + "eksPropertiesOverride":{"shape":"EksPropertiesOverride"} } }, "SubmitJobResponse":{ diff --git a/models/apis/batch/2016-08-10/docs-2.json b/models/apis/batch/2016-08-10/docs-2.json index f05ee8bf3d..aac0958dd8 100644 --- a/models/apis/batch/2016-08-10/docs-2.json +++ b/models/apis/batch/2016-08-10/docs-2.json @@ -1,9 +1,9 @@ { "version": "2.0", - "service": "Batch

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.

", + "service": "Batch

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently provision resources d, and work toward eliminating capacity constraints, reducing your overall compute costs, and delivering results more quickly.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus on analyzing results and solving your specific problems instead.

", "operations": { - "CancelJob": "

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

", - "CreateComputeEnvironment": "

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.

Multi-node parallel jobs aren't supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the earlier compute environment from your job queue.

  4. Delete the earlier compute environment.

In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template will be evaluated up at the time of the infrastructure update, even if the launchTemplate was not updated.

", + "CancelJob": "

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

", + "CreateComputeEnvironment": "

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.

Multi-node parallel jobs aren't supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the earlier compute environment from your job queue.

  4. Delete the earlier compute environment.

In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.

", "CreateJobQueue": "

Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

", "CreateSchedulingPolicy": "

Creates an Batch scheduling policy.

", "DeleteComputeEnvironment": "

Deletes an Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

", @@ -17,10 +17,10 @@ "DescribeSchedulingPolicies": "

Describes one or more of your scheduling policies.

", "ListJobs": "

Returns a list of Batch jobs.

You must specify only one of the following items:

You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.

", "ListSchedulingPolicies": "

Returns a list of Batch scheduling policies.

", - "ListTagsForResource": "

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "ListTagsForResource": "

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", "RegisterJobDefinition": "

Registers an Batch job definition.

", "SubmitJob": "

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.

Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.

", - "TagResource": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "TagResource": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", "TerminateJob": "

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

", "UntagResource": "

Deletes specified tags from an Batch resource.

", "UpdateComputeEnvironment": "

Updates an Batch compute environment.

", @@ -41,37 +41,37 @@ } }, "ArrayProperties": { - "base": "

An object representing an Batch array job.

", + "base": "

An object that represents an Batch array job.

", "refs": { "SubmitJobRequest$arrayProperties": "

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the Batch User Guide.

" } }, "ArrayPropertiesDetail": { - "base": "

An object representing the array properties of a job.

", + "base": "

An object that represents the array properties of a job.

", "refs": { - "JobDetail$arrayProperties": "

The array properties of the job, if it is an array job.

" + "JobDetail$arrayProperties": "

The array properties of the job, if it's an array job.

" } }, "ArrayPropertiesSummary": { - "base": "

An object representing the array properties of a job.

", + "base": "

An object that represents the array properties of a job.

", "refs": { - "JobSummary$arrayProperties": "

The array properties of the job, if it is an array job.

" + "JobSummary$arrayProperties": "

The array properties of the job, if it's an array job.

" } }, "AssignPublicIp": { "base": null, "refs": { - "NetworkConfiguration$assignPublicIp": "

Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is \"DISABLED\".

" + "NetworkConfiguration$assignPublicIp": "

Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is \"DISABLED\".

" } }, "AttemptContainerDetail": { - "base": "

An object representing the details of a container that's part of a job attempt.

", + "base": "

An object that represents the details of a container that's part of a job attempt.

", "refs": { - "AttemptDetail$container": "

Details about the container in this job attempt.

" + "AttemptDetail$container": "

The details for the container in this job attempt.

" } }, "AttemptDetail": { - "base": "

An object representing a job attempt.

", + "base": "

An object that represents a job attempt.

", "refs": { "AttemptDetails$member": null } @@ -79,24 +79,31 @@ "AttemptDetails": { "base": null, "refs": { - "JobDetail$attempts": "

A list of job attempts associated with this job.

" + "JobDetail$attempts": "

A list of job attempts that are associated with this job.

" } }, "Boolean": { "base": null, "refs": { - "ComputeResourceUpdate$updateToLatestImageVersion": "

Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute environment has an infrastructure update. The default value is false.

If an AMI ID is specified in the imageId or imageIdOverride parameters or by the launch template specified in the launchTemplate parameter, this parameter is ignored. For more information on updating AMI IDs during an infrastructure update, see Updating the AMI ID in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

", + "ComputeResourceUpdate$updateToLatestImageVersion": "

Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute environment has an infrastructure update. The default value is false.

An AMI ID can either be specified in the imageId or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see Updating the AMI ID in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

", "ContainerDetail$readonlyRootFilesystem": "

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .

", - "ContainerDetail$privileged": "

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

", + "ContainerDetail$privileged": "

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

", "ContainerProperties$readonlyRootFilesystem": "

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

", "ContainerProperties$privileged": "

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the 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 shouldn't be provided, or specified as false.

", - "JobDefinition$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

", - "JobDetail$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

", - "LinuxParameters$initProcessEnabled": "

If true, run an init process inside the container that forwards signals and 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 container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

", + "EksContainerSecurityContext$privileged": "

When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

", + "EksContainerSecurityContext$readOnlyRootFilesystem": "

When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

", + "EksContainerSecurityContext$runAsNonRoot": "

When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

", + "EksContainerVolumeMount$readOnly": "

If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

", + "EksPodProperties$hostNetwork": "

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

", + "EksPodPropertiesDetail$hostNetwork": "

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

", + "EksSecret$optional": "

Specifies whether the secret or the secret's keys must be defined.

", + "JobDefinition$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

", + "JobDetail$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

", + "LinuxParameters$initProcessEnabled": "

If true, run an init process inside the container that forwards signals and 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 container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

", "MountPoint$readOnly": "

If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

", "NodeDetails$isMainNode": "

Specifies whether the current node is the main node for a multi-node parallel job.

", "NodePropertiesSummary$isMainNode": "

Specifies whether the current node is the main node for a multi-node parallel job.

", - "RegisterJobDefinitionRequest$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

", + "RegisterJobDefinitionRequest$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job 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 propagateTags.

", "SubmitJobRequest$propagateTags": "

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

", "UpdatePolicy$terminateJobsOnUpdate": "

Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is false.

" } @@ -104,7 +111,7 @@ "CEState": { "base": null, "refs": { - "ComputeEnvironmentDetail$state": "

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

", + "ComputeEnvironmentDetail$state": "

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

", "CreateComputeEnvironmentRequest$state": "

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

", "UpdateComputeEnvironmentRequest$state": "

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

" } @@ -125,7 +132,7 @@ "CRAllocationStrategy": { "base": null, "refs": { - "ComputeResource$allocationStrategy": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
BEST_FIT (default)

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide.

BEST_FIT_PROGRESSIVE

Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, Batch will select new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "ComputeResource$allocationStrategy": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
BEST_FIT (default)

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide.

BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" } }, "CRType": { @@ -138,7 +145,7 @@ "CRUpdateAllocationStrategy": { "base": null, "refs": { - "ComputeResourceUpdate$allocationStrategy": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn't supported when updating a compute environment.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
BEST_FIT_PROGRESSIVE

Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, Batch will select new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "ComputeResourceUpdate$allocationStrategy": "

The allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn't supported when updating a compute environment.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" } }, "CancelJobRequest": { @@ -152,12 +159,12 @@ } }, "ClientException": { - "base": "

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that's not valid.

", + "base": "

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

", "refs": { } }, "ComputeEnvironmentDetail": { - "base": "

An object representing an Batch compute environment.

", + "base": "

An object that represents an Batch compute environment.

", "refs": { "ComputeEnvironmentDetailList$member": null } @@ -169,7 +176,7 @@ } }, "ComputeEnvironmentOrder": { - "base": "

The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or 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 architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

", + "base": "

The order that compute environments are tried in for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or 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 architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

", "refs": { "ComputeEnvironmentOrders$member": null } @@ -183,43 +190,43 @@ } }, "ComputeResource": { - "base": "

An object representing an Batch compute resource. For more information, see Compute environments in the Batch User Guide.

", + "base": "

An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.

", "refs": { "ComputeEnvironmentDetail$computeResources": "

The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

", "CreateComputeEnvironmentRequest$computeResources": "

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Batch User Guide.

" } }, "ComputeResourceUpdate": { - "base": "

An object representing the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.

", + "base": "

An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.

", "refs": { "UpdateComputeEnvironmentRequest$computeResources": "

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

" } }, "ContainerDetail": { - "base": "

An object representing the details of a container that's part of a job.

", + "base": "

An object that represents the details of a container that's part of a job.

", "refs": { - "JobDetail$container": "

An object representing the details of the container that's associated with the job.

" + "JobDetail$container": "

An object that represents the details for the container that's associated with the job.

" } }, "ContainerOverrides": { "base": "

The overrides that should be sent to a container.

", "refs": { - "NodePropertyOverride$containerOverrides": "

The overrides that should be sent to a node range.

", - "SubmitJobRequest$containerOverrides": "

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it receives. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

" + "NodePropertyOverride$containerOverrides": "

The overrides that are sent to a node range.

", + "SubmitJobRequest$containerOverrides": "

An object with various properties that override the defaults for the job definition that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

" } }, "ContainerProperties": { - "base": "

Container properties are used in job definitions to describe the container that's launched as part of a job.

", + "base": "

Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

", "refs": { - "JobDefinition$containerProperties": "

An object with various properties specific to container-based jobs.

", + "JobDefinition$containerProperties": "

An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

", "NodeRangeProperty$container": "

The container details for the node range.

", - "RegisterJobDefinitionRequest$containerProperties": "

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

" + "RegisterJobDefinitionRequest$containerProperties": "

An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS based job definitions.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

" } }, "ContainerSummary": { - "base": "

An object representing summary details of a container within a job.

", + "base": "

An object that represents summary details of a container within a job.

", "refs": { - "JobSummary$container": "

An object representing the details of the container that's associated with the job.

" + "JobSummary$container": "

An object that represents the details of the container that's associated with the job.

" } }, "CreateComputeEnvironmentRequest": { @@ -343,7 +350,7 @@ } }, "Device": { - "base": "

An object representing a container instance host device.

This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

", + "base": "

An object that represents a container instance host device.

This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

", "refs": { "DevicesList$member": null } @@ -363,7 +370,7 @@ "DevicesList": { "base": null, "refs": { - "LinuxParameters$devices": "

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

" + "LinuxParameters$devices": "

Any of the host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

" } }, "EFSAuthorizationConfig": { @@ -387,7 +394,7 @@ "EFSVolumeConfiguration": { "base": "

This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.

", "refs": { - "Volume$efsVolumeConfiguration": "

This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

" + "Volume$efsVolumeConfiguration": "

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

" } }, "Ec2Configuration": { @@ -399,20 +406,209 @@ "Ec2ConfigurationList": { "base": null, "refs": { - "ComputeResource$ec2Configuration": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$ec2Configuration": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

" + "ComputeResource$ec2Configuration": "

Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$ec2Configuration": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

" + } + }, + "EksAttemptContainerDetail": { + "base": "

An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.

", + "refs": { + "EksAttemptContainerDetails$member": null + } + }, + "EksAttemptContainerDetails": { + "base": null, + "refs": { + "EksAttemptDetail$containers": "

The details for the final status of the containers for this job attempt.

" + } + }, + "EksAttemptDetail": { + "base": "

An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.

", + "refs": { + "EksAttemptDetails$member": null + } + }, + "EksAttemptDetails": { + "base": null, + "refs": { + "JobDetail$eksAttempts": "

A list of job attempts that are associated with this job.

" + } + }, + "EksConfiguration": { + "base": "

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

", + "refs": { + "ComputeEnvironmentDetail$eksConfiguration": "

The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

", + "CreateComputeEnvironmentRequest$eksConfiguration": "

The details for the Amazon EKS cluster that supports the compute environment.

" + } + }, + "EksContainer": { + "base": "

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.

", + "refs": { + "EksContainers$member": null + } + }, + "EksContainerDetail": { + "base": "

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

", + "refs": { + "EksContainerDetails$member": null + } + }, + "EksContainerDetails": { + "base": null, + "refs": { + "EksPodPropertiesDetail$containers": "

The properties of the container that's used on the Amazon EKS pod.

" + } + }, + "EksContainerEnvironmentVariable": { + "base": "

An environment variable.

", + "refs": { + "EksContainerEnvironmentVariables$member": null + } + }, + "EksContainerEnvironmentVariables": { + "base": null, + "refs": { + "EksContainer$env": "

The environment variables to pass to a container.

Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets.

", + "EksContainerDetail$env": "

The environment variables to pass to a container.

Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets.

", + "EksContainerOverride$env": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch. Or, you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets.

" + } + }, + "EksContainerOverride": { + "base": "

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

", + "refs": { + "EksContainerOverrideList$member": null + } + }, + "EksContainerOverrideList": { + "base": null, + "refs": { + "EksPodPropertiesOverride$containers": "

The overrides for the container that's used on the Amazon EKS pod.

" + } + }, + "EksContainerResourceRequirements": { + "base": "

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

", + "refs": { + "EksContainer$resources": "

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

", + "EksContainerDetail$resources": "

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

", + "EksContainerOverride$resources": "

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

" + } + }, + "EksContainerSecurityContext": { + "base": "

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

", + "refs": { + "EksContainer$securityContext": "

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

", + "EksContainerDetail$securityContext": "

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

" + } + }, + "EksContainerVolumeMount": { + "base": "

The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

", + "refs": { + "EksContainerVolumeMounts$member": null + } + }, + "EksContainerVolumeMounts": { + "base": null, + "refs": { + "EksContainer$volumeMounts": "

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

", + "EksContainerDetail$volumeMounts": "

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

" + } + }, + "EksContainers": { + "base": null, + "refs": { + "EksPodProperties$containers": "

The properties of the container that's used on the Amazon EKS pod.

" + } + }, + "EksEmptyDir": { + "base": "

Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first created when a pod is assigned to a node. It exists as long as that pod is running on that node. The emptyDir volume is initially empty. All containers in the pod can read and write the files in the emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths in each container. When a pod is removed from a node for any reason, the data in the emptyDir is deleted permanently. For more information, see emptyDir in the Kubernetes documentation.

", + "refs": { + "EksVolume$emptyDir": "

Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes documentation.

" + } + }, + "EksHostPath": { + "base": "

Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes documentation.

", + "refs": { + "EksVolume$hostPath": "

Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes documentation.

" + } + }, + "EksLimits": { + "base": null, + "refs": { + "EksContainerResourceRequirements$limits": "

The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.
cpu

The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

" + } + }, + "EksPodProperties": { + "base": "

The properties for the pod.

", + "refs": { + "EksProperties$podProperties": "

The properties for the Kubernetes pod resources of a job.

" + } + }, + "EksPodPropertiesDetail": { + "base": "

The details for the pod.

", + "refs": { + "EksPropertiesDetail$podProperties": "

The properties for the Kubernetes pod resources of a job.

" + } + }, + "EksPodPropertiesOverride": { + "base": "

An object that contains overrides for the Kubernetes pod properties of a job.

", + "refs": { + "EksPropertiesOverride$podProperties": "

The overrides for the Kubernetes pod resources of a job.

" + } + }, + "EksProperties": { + "base": "

An object that contains the properties for the Kubernetes resources of a job.

", + "refs": { + "JobDefinition$eksProperties": "

An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

", + "RegisterJobDefinitionRequest$eksProperties": "

An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS based job definitions.

" + } + }, + "EksPropertiesDetail": { + "base": "

An object that contains the details for the Kubernetes resources of a job.

", + "refs": { + "JobDetail$eksProperties": "

An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

" + } + }, + "EksPropertiesOverride": { + "base": "

An object that contains overrides for the Kubernetes resources of a job.

", + "refs": { + "SubmitJobRequest$eksPropertiesOverride": "

An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.

" + } + }, + "EksRequests": { + "base": null, + "refs": { + "EksContainerResourceRequirements$requests": "

The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

" + } + }, + "EksSecret": { + "base": "

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

", + "refs": { + "EksVolume$secret": "

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

" + } + }, + "EksVolume": { + "base": "

Specifies an Amazon EKS volume for a job definition.

", + "refs": { + "EksVolumes$member": null + } + }, + "EksVolumes": { + "base": null, + "refs": { + "EksPodProperties$volumes": "

Specifies the volumes for a job definition that uses Amazon EKS resources.

", + "EksPodPropertiesDetail$volumes": "

Specifies the volumes for a job definition using Amazon EKS resources.

" } }, "EnvironmentVariables": { "base": null, "refs": { - "ContainerDetail$environment": "

The environment variables to pass to a container.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

", - "ContainerOverrides$environment": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

", - "ContainerProperties$environment": "

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

" + "ContainerDetail$environment": "

The environment variables to pass to a container.

Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets.

", + "ContainerOverrides$environment": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets.

", + "ContainerProperties$environment": "

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets.

" } }, "EvaluateOnExit": { - "base": "

Specifies a set of conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met.

", + "base": "

Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.

", "refs": { "EvaluateOnExitList$member": null } @@ -420,7 +616,7 @@ "EvaluateOnExitList": { "base": null, "refs": { - "RetryStrategy$evaluateOnExit": "

Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified.

" + "RetryStrategy$evaluateOnExit": "

Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the attempts parameter must also be specified. If none of the listed conditions match, then the job is retried.

" } }, "FairsharePolicy": { @@ -445,9 +641,9 @@ } }, "Host": { - "base": "

Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data isn't guaranteed to persist after the containers associated with it stop running.

", + "base": "

Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

", "refs": { - "Volume$host": "

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

" + "Volume$host": "

The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to 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 shouldn't be provided.

" } }, "ImageIdOverride": { @@ -459,7 +655,7 @@ "ImageType": { "base": null, "refs": { - "Ec2Configuration$imageType": "

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by Batch is used.

ECS_AL2

Amazon Linux 2− Default for all non-GPU instance families.

ECS_AL2_NVIDIA

Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

ECS_AL1

Amazon Linux. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

" + "Ec2Configuration$imageType": "

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

ECS

If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by Batch is used.

ECS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

ECS_AL2_NVIDIA

Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

ECS_AL1

Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

EKS

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

EKS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

EKS_AL2_NVIDIA

Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

" } }, "Integer": { @@ -471,24 +667,24 @@ "ArrayPropertiesDetail$index": "

The job index within the array that's associated with this job. This parameter is returned for array job children.

", "ArrayPropertiesSummary$size": "

The size of the array job. This parameter is returned for parent array jobs.

", "ArrayPropertiesSummary$index": "

The job index within the array that's associated with this job. This parameter is returned for children of array jobs.

", - "AttemptContainerDetail$exitCode": "

The exit code for the job attempt. A non-zero exit code is considered a failure.

", + "AttemptContainerDetail$exitCode": "

The exit code for the job attempt. A non-zero exit code is considered failed.

", "ComputeEnvironmentDetail$unmanagedvCpus": "

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

", "ComputeEnvironmentOrder$order": "

The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

", - "ComputeResource$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResource$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.

", - "ComputeResource$desiredvCpus": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values, based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResource$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.

", - "ComputeResourceUpdate$desiredvCpus": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage.

When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", + "ComputeResource$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResource$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.

", + "ComputeResource$desiredvCpus": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResource$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.

", + "ComputeResourceUpdate$desiredvCpus": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage.

When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ContainerDetail$vcpus": "

The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but 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 on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

", "ContainerDetail$memory": "

For jobs running on EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

", "ContainerDetail$exitCode": "

The exit code to return upon completion.

", - "ContainerOverrides$vcpus": "

This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

", - "ContainerOverrides$memory": "

This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

", + "ContainerOverrides$vcpus": "

This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

", + "ContainerOverrides$memory": "

This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

", "ContainerProperties$vcpus": "

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

", - "ContainerProperties$memory": "

This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

", + "ContainerProperties$memory": "

This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

", "ContainerSummary$exitCode": "

The exit code to return upon completion.

", "CreateComputeEnvironmentRequest$unmanagedvCpus": "

The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

This parameter is only supported when the type parameter is set to UNMANAGED.

", "CreateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

", @@ -496,32 +692,34 @@ "DescribeJobDefinitionsRequest$maxResults": "

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

", "DescribeJobQueuesRequest$maxResults": "

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

", "EFSVolumeConfiguration$transitEncryptionPort": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

", - "FairsharePolicy$shareDecaySeconds": "

The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

", - "FairsharePolicy$computeReservation": "

A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

", + "EksAttemptContainerDetail$exitCode": "

The exit code for the job attempt. A non-zero exit code is considered failed.

", + "EksContainerDetail$exitCode": "

The exit code for the job attempt. A non-zero exit code is considered failed.

", + "FairsharePolicy$shareDecaySeconds": "

The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

", + "FairsharePolicy$computeReservation": "

A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

", "JobDefinition$revision": "

The revision of the job definition.

", "JobDefinition$schedulingPriority": "

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

", "JobDetail$schedulingPriority": "

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

", - "JobQueueDetail$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

", - "JobTimeout$attemptDurationSeconds": "

The time duration in seconds (measured from the job attempt's startedAt timestamp) after which Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.

", - "LinuxParameters$sharedMemorySize": "

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

", - "LinuxParameters$maxSwap": "

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

", - "LinuxParameters$swappiness": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

", + "JobQueueDetail$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

", + "JobTimeout$attemptDurationSeconds": "

The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.

", + "LinuxParameters$sharedMemorySize": "

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

", + "LinuxParameters$maxSwap": "

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

", + "LinuxParameters$swappiness": "

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

", "ListJobsRequest$maxResults": "

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

", "ListSchedulingPoliciesRequest$maxResults": "

The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

", - "NodeDetails$nodeIndex": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

", - "NodeOverrides$numNodes": "

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

", - "NodeProperties$numNodes": "

The number of nodes associated with a multi-node parallel job.

", + "NodeDetails$nodeIndex": "

The node index for the node. Node index numbering starts at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

", + "NodeOverrides$numNodes": "

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

", + "NodeProperties$numNodes": "

The number of nodes that are associated with a multi-node parallel job.

", "NodeProperties$mainNode": "

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

", - "NodePropertiesSummary$numNodes": "

The number of nodes associated with a multi-node parallel job.

", + "NodePropertiesSummary$numNodes": "

The number of nodes that are associated with a multi-node parallel job.

", "NodePropertiesSummary$nodeIndex": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

", - "RegisterJobDefinitionRequest$schedulingPriority": "

The scheduling priority for jobs that are submitted with this job definition. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

", + "RegisterJobDefinitionRequest$schedulingPriority": "

The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

", "RegisterJobDefinitionResponse$revision": "

The revision of the job definition.

", "RetryStrategy$attempts": "

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

", - "SubmitJobRequest$schedulingPriorityOverride": "

The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job definition.

The minimum supported value is 0 and the maximum supported value is 9999.

", - "Tmpfs$size": "

The size (in MiB) of the tmpfs volume.

", + "SubmitJobRequest$schedulingPriorityOverride": "

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition.

The minimum supported value is 0 and the maximum supported value is 9999.

", + "Tmpfs$size": "

The size (in MiB) of the tmpfs volume.

", "Ulimit$hardLimit": "

The hard limit for the ulimit type.

", "Ulimit$softLimit": "

The soft limit for the ulimit type.

", - "UpdateComputeEnvironmentRequest$unmanagedvCpus": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Do not specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be reserved.

", + "UpdateComputeEnvironmentRequest$unmanagedvCpus": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

", "UpdateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

" } }, @@ -529,7 +727,7 @@ "base": null, "refs": { "CreateJobQueueRequest$state": "

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

", - "JobQueueDetail$state": "

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it's able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

", + "JobQueueDetail$state": "

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

", "UpdateJobQueueRequest$state": "

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

" } }, @@ -540,7 +738,7 @@ } }, "JobDefinition": { - "base": "

An object representing an Batch job definition.

", + "base": "

An object that represents an Batch job definition.

", "refs": { "JobDefinitionList$member": null } @@ -558,7 +756,7 @@ } }, "JobDependency": { - "base": "

An object representing an Batch job dependency.

", + "base": "

An object that represents an Batch job dependency.

", "refs": { "JobDependencyList$member": null } @@ -571,7 +769,7 @@ } }, "JobDetail": { - "base": "

An object representing an Batch job.

", + "base": "

An object that represents an Batch job.

", "refs": { "JobDetailList$member": null } @@ -585,11 +783,11 @@ "JobExecutionTimeoutMinutes": { "base": null, "refs": { - "UpdatePolicy$jobExecutionTimeoutMinutes": "

Specifies the job timeout, in minutes, when the compute environment infrastructure is updated. The default value is 30.

" + "UpdatePolicy$jobExecutionTimeoutMinutes": "

Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30.

" } }, "JobQueueDetail": { - "base": "

An object representing the details of an Batch job queue.

", + "base": "

An object that represents the details for an Batch job queue.

", "refs": { "JobQueueDetailList$member": null } @@ -609,7 +807,7 @@ } }, "JobSummary": { - "base": "

An object representing summary details of a job.

", + "base": "

An object that represents summary details of a job.

", "refs": { "JobSummaryList$member": null } @@ -621,9 +819,9 @@ } }, "JobTimeout": { - "base": "

An object representing a job timeout configuration.

", + "base": "

An object that represents a job timeout configuration.

", "refs": { - "JobDefinition$timeout": "

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.

", + "JobDefinition$timeout": "

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

", "JobDetail$timeout": "

The timeout configuration for the job.

", "RegisterJobDefinitionRequest$timeout": "

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

", "SubmitJobRequest$timeout": "

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

" @@ -641,11 +839,17 @@ "ListJobsFilterList$member": null } }, + "KubernetesVersion": { + "base": null, + "refs": { + "Ec2Configuration$imageKubernetesVersion": "

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.

" + } + }, "LaunchTemplateSpecification": { - "base": "

An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.

This object isn't applicable to jobs that are running on Fargate resources.

", + "base": "

An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.

This object isn't applicable to jobs that are running on Fargate resources.

", "refs": { - "ComputeResource$launchTemplate": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$launchTemplate": "

The updated launch template to use for your compute resources. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide. To remove the custom launch template and use the default launch template, set launchTemplateId or launchTemplateName member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to true.

When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

" + "ComputeResource$launchTemplate": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$launchTemplate": "

The updated launch template to use for your compute resources. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide. To remove the custom launch template and use the default launch template, set launchTemplateId or launchTemplateName member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to true.

When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

" } }, "LinuxParameters": { @@ -658,7 +862,7 @@ "ListJobsFilterList": { "base": null, "refs": { - "ListJobsRequest$filters": "

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter will match any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter will match any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) is not supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

" + "ListJobsRequest$filters": "

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

" } }, "ListJobsRequest": { @@ -694,20 +898,20 @@ "LogConfiguration": { "base": "

Log configuration options to send to a custom log driver for the container.

", "refs": { - "ContainerDetail$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available 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 instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

", - "ContainerProperties$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

" + "ContainerDetail$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available 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 instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

", + "ContainerProperties$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

" } }, "LogConfigurationOptionsMap": { "base": null, "refs": { - "LogConfiguration$options": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + "LogConfiguration$options": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

" } }, "LogDriver": { "base": null, "refs": { - "LogConfiguration$logDriver": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + "LogConfiguration$logDriver": "

The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

" } }, "Long": { @@ -715,16 +919,20 @@ "refs": { "AttemptDetail$startedAt": "

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

", "AttemptDetail$stoppedAt": "

The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

", - "JobDetail$createdAt": "

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

", - "JobDetail$startedAt": "

The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

", - "JobDetail$stoppedAt": "

The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

", + "EksAttemptDetail$startedAt": "

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

", + "EksAttemptDetail$stoppedAt": "

The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

", + "EksContainerSecurityContext$runAsUser": "

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

", + "EksContainerSecurityContext$runAsGroup": "

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

", + "JobDetail$createdAt": "

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

", + "JobDetail$startedAt": "

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state. This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

", + "JobDetail$stoppedAt": "

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

", "JobSummary$createdAt": "

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

", - "JobSummary$startedAt": "

The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

", - "JobSummary$stoppedAt": "

The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

" + "JobSummary$startedAt": "

The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

", + "JobSummary$stoppedAt": "

The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

" } }, "MountPoint": { - "base": "

Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

", + "base": "

Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

", "refs": { "MountPoints$member": null } @@ -744,7 +952,7 @@ } }, "NetworkInterface": { - "base": "

An object representing the elastic network interface for a multi-node parallel job node.

", + "base": "

An object that represents the elastic network interface for a multi-node parallel job node.

", "refs": { "NetworkInterfaceList$member": null } @@ -752,38 +960,38 @@ "NetworkInterfaceList": { "base": null, "refs": { - "AttemptContainerDetail$networkInterfaces": "

The network interfaces associated with the job attempt.

", - "ContainerDetail$networkInterfaces": "

The network interfaces associated with the job.

" + "AttemptContainerDetail$networkInterfaces": "

The network interfaces that are associated with the job attempt.

", + "ContainerDetail$networkInterfaces": "

The network interfaces that are associated with the job.

" } }, "NodeDetails": { - "base": "

An object representing the details of a multi-node parallel job node.

", + "base": "

An object that represents the details of a multi-node parallel job node.

", "refs": { - "JobDetail$nodeDetails": "

An object representing the details of a node that's associated with a multi-node parallel job.

" + "JobDetail$nodeDetails": "

An object that represents the details of a node that's associated with a multi-node parallel job.

" } }, "NodeOverrides": { - "base": "

Object representing any node overrides to a job definition that's used in a SubmitJob API operation.

This isn't applicable to jobs that are running on Fargate resources and shouldn't be provided; use containerOverrides instead.

", + "base": "

An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs. Rather, use containerOverrides instead.

", "refs": { "SubmitJobRequest$nodeOverrides": "

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.

" } }, "NodeProperties": { - "base": "

An object representing the node properties of a multi-node parallel job.

", + "base": "

An object that represents the node properties of a multi-node parallel job.

Node properties can't be specified for Amazon EKS based job definitions.

", "refs": { - "JobDefinition$nodeProperties": "

An object with various properties specific to multi-node parallel jobs.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

", - "JobDetail$nodeProperties": "

An object representing the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

", - "RegisterJobDefinitionRequest$nodeProperties": "

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

" + "JobDefinition$nodeProperties": "

An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

", + "JobDetail$nodeProperties": "

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

", + "RegisterJobDefinitionRequest$nodeProperties": "

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

If the job runs on Amazon EKS resources, then you must not specify nodeProperties.

" } }, "NodePropertiesSummary": { - "base": "

An object representing the properties of a node that's associated with a multi-node parallel job.

", + "base": "

An object that represents the properties of a node that's associated with a multi-node parallel job.

", "refs": { "JobSummary$nodeProperties": "

The node properties for a single node in a job summary list.

This isn't applicable to jobs that are running on Fargate resources.

" } }, "NodePropertyOverride": { - "base": "

Object representing any node overrides to a job definition that's used in a SubmitJob API operation.

", + "base": "

The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

", "refs": { "NodePropertyOverrides$member": null } @@ -797,20 +1005,27 @@ "NodeRangeProperties": { "base": null, "refs": { - "NodeProperties$nodeRangeProperties": "

A list of node ranges and their properties associated with a multi-node parallel job.

" + "NodeProperties$nodeRangeProperties": "

A list of node ranges and their properties that are associated with a multi-node parallel job.

" } }, "NodeRangeProperty": { - "base": "

An object representing the properties of the node range for a multi-node parallel job.

", + "base": "

An object that represents the properties of the node range for a multi-node parallel job.

", "refs": { "NodeRangeProperties$member": null } }, + "OrchestrationType": { + "base": null, + "refs": { + "ComputeEnvironmentDetail$containerOrchestrationType": "

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

", + "JobDefinition$containerOrchestrationType": "

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

" + } + }, "ParametersMap": { "base": null, "refs": { "JobDefinition$parameters": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.

", - "JobDetail$parameters": "

Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

", + "JobDetail$parameters": "

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

", "RegisterJobDefinitionRequest$parameters": "

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

", "SubmitJobRequest$parameters": "

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

" } @@ -826,7 +1041,15 @@ "refs": { "JobDefinition$platformCapabilities": "

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

", "JobDetail$platformCapabilities": "

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

", - "RegisterJobDefinitionRequest$platformCapabilities": "

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

" + "RegisterJobDefinitionRequest$platformCapabilities": "

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.

" + } + }, + "Quantity": { + "base": null, + "refs": { + "EksEmptyDir$sizeLimit": "

The maximum size of the volume. By default, there's no maximum size defined.

", + "EksLimits$value": null, + "EksRequests$value": null } }, "RegisterJobDefinitionRequest": { @@ -866,7 +1089,7 @@ } }, "RetryStrategy": { - "base": "

The retry strategy associated with a job. For more information, see Automated job retries in the Batch User Guide.

", + "base": "

The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

", "refs": { "JobDefinition$retryStrategy": "

The retry strategy to use for failed jobs that are submitted with this job definition.

", "JobDetail$retryStrategy": "

The retry strategy to use for this job if an attempt fails.

", @@ -899,7 +1122,7 @@ } }, "Secret": { - "base": "

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

For more information, see Specifying sensitive data in the Batch User Guide.

", + "base": "

An object that represents the secret to expose to your container. Secrets can be exposed to a container in the following ways:

For more information, see Specifying sensitive data in the Batch User Guide.

", "refs": { "SecretList$member": null } @@ -935,96 +1158,127 @@ "ArrayJobStatusSummary$key": null, "AttemptContainerDetail$containerInstanceArn": "

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

", "AttemptContainerDetail$taskArn": "

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

", - "AttemptContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

", - "AttemptContainerDetail$logStreamName": "

The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", - "AttemptDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the job attempt.

", + "AttemptContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

", + "AttemptContainerDetail$logStreamName": "

The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", + "AttemptDetail$statusReason": "

A short, human-readable string to provide additional details for the current status of the job attempt.

", "CancelJobRequest$jobId": "

The Batch job ID of the job to cancel.

", "CancelJobRequest$reason": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

", "ClientException$message": null, - "ComputeEnvironmentDetail$computeEnvironmentName": "

The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", + "ComputeEnvironmentDetail$computeEnvironmentName": "

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "ComputeEnvironmentDetail$computeEnvironmentArn": "

The Amazon Resource Name (ARN) of the compute environment.

", - "ComputeEnvironmentDetail$ecsClusterArn": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

", - "ComputeEnvironmentDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the compute environment.

", - "ComputeEnvironmentDetail$serviceRole": "

The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

", + "ComputeEnvironmentDetail$ecsClusterArn": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

", + "ComputeEnvironmentDetail$statusReason": "

A short, human-readable string to provide additional details for the current status of the compute environment.

", + "ComputeEnvironmentDetail$serviceRole": "

The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

", + "ComputeEnvironmentDetail$uuid": "

Unique identifier for the compute environment.

", "ComputeEnvironmentOrder$computeEnvironment": "

The Amazon Resource Name (ARN) of the compute environment.

", - "ComputeResource$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", - "ComputeResource$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResource$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . 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, and shouldn't be specified.

", - "ComputeResource$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResource$spotIamFleetRole": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.

", - "ComputeResourceUpdate$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . 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 of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", + "ComputeResource$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", + "ComputeResource$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResource$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . 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.

", + "ComputeResource$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResource$spotIamFleetRole": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.

", + "ComputeResourceUpdate$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . 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 of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", "ContainerDetail$image": "

The image used to start the container.

", - "ContainerDetail$jobRoleArn": "

The Amazon Resource Name (ARN) associated with the job upon execution.

", + "ContainerDetail$jobRoleArn": "

The Amazon Resource Name (ARN) that's associated with the job when run.

", "ContainerDetail$executionRoleArn": "

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.

", "ContainerDetail$user": "

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

", - "ContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

", + "ContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

", "ContainerDetail$containerInstanceArn": "

The Amazon Resource Name (ARN) of the container instance that the container is running on.

", "ContainerDetail$taskArn": "

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

", - "ContainerDetail$logStreamName": "

The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", + "ContainerDetail$logStreamName": "

The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", "ContainerDetail$instanceType": "

The instance type of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

", "ContainerOverrides$instanceType": "

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

", - "ContainerProperties$image": "

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

 ", + "ContainerProperties$image": "

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

 ", "ContainerProperties$jobRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

", "ContainerProperties$executionRoleArn": "

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

", "ContainerProperties$user": "

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

", "ContainerProperties$instanceType": "

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

", - "ContainerSummary$reason": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

", - "CreateComputeEnvironmentRequest$computeEnvironmentName": "

The name for your compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", - "CreateComputeEnvironmentRequest$serviceRole": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

", - "CreateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", + "ContainerSummary$reason": "

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

", + "CreateComputeEnvironmentRequest$computeEnvironmentName": "

The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", + "CreateComputeEnvironmentRequest$serviceRole": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/, specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

", + "CreateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "CreateComputeEnvironmentResponse$computeEnvironmentArn": "

The Amazon Resource Name (ARN) of the compute environment.

", "CreateJobQueueRequest$jobQueueName": "

The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", - "CreateJobQueueRequest$schedulingPolicyArn": "

The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . An example is aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

", + "CreateJobQueueRequest$schedulingPolicyArn": "

The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

", "CreateJobQueueResponse$jobQueueName": "

The name of the job queue.

", "CreateJobQueueResponse$jobQueueArn": "

The Amazon Resource Name (ARN) of the job queue.

", "CreateSchedulingPolicyRequest$name": "

The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "CreateSchedulingPolicyResponse$name": "

The name of the scheduling policy.

", - "CreateSchedulingPolicyResponse$arn": "

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

", + "CreateSchedulingPolicyResponse$arn": "

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

", "DeleteComputeEnvironmentRequest$computeEnvironment": "

The name or Amazon Resource Name (ARN) of the compute environment to delete.

", "DeleteJobQueueRequest$jobQueue": "

The short name or full Amazon Resource Name (ARN) of the queue to delete.

", "DeleteSchedulingPolicyRequest$arn": "

The Amazon Resource Name (ARN) of the scheduling policy to delete.

", "DeregisterJobDefinitionRequest$jobDefinition": "

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

", - "DescribeComputeEnvironmentsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

", + "DescribeComputeEnvironmentsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 retrieve the next items in a list and not for other programmatic purposes.

", "DescribeComputeEnvironmentsResponse$nextToken": "

The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeComputeEnvironments 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.

", "DescribeJobDefinitionsRequest$jobDefinitionName": "

The name of the job definition to describe.

", "DescribeJobDefinitionsRequest$status": "

The status used to filter job definitions.

", - "DescribeJobDefinitionsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobDefinitions 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.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

", + "DescribeJobDefinitionsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 retrieve the next items in a list and not for other programmatic purposes.

", "DescribeJobDefinitionsResponse$nextToken": "

The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions 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.

", - "DescribeJobQueuesRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobQueues 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.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

", + "DescribeJobQueuesRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobQueues 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 retrieve the next items in a list and not for other programmatic purposes.

", "DescribeJobQueuesResponse$nextToken": "

The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues 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.

", "Device$hostPath": "

The path for the device on the host container instance.

", "Device$containerPath": "

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

", - "EFSAuthorizationConfig$accessPointId": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

", + "EFSAuthorizationConfig$accessPointId": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

", "EFSVolumeConfiguration$fileSystemId": "

The Amazon EFS file system ID to use.

", "EFSVolumeConfiguration$rootDirectory": "

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

", - "EvaluateOnExit$onStatusReason": "

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can be between 1 and 512 characters in length.

", - "EvaluateOnExit$onReason": "

Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can be between 1 and 512 characters in length.

", - "EvaluateOnExit$onExitCode": "

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can be between 1 and 512 characters in length.

", + "EksAttemptContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

", + "EksAttemptDetail$podName": "

The name of the pod for this job attempt.

", + "EksAttemptDetail$nodeName": "

The name of the node for this job attempt.

", + "EksAttemptDetail$statusReason": "

A short, human-readable string to provide additional details for the current status of the job attempt.

", + "EksConfiguration$eksClusterArn": "

The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .

", + "EksConfiguration$kubernetesNamespace": "

The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with \"kube-,\" and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.

", + "EksContainer$name": "

The name of the container. If the name isn't specified, the default name \"Default\" is used. Each container in a pod must have a unique name.

", + "EksContainer$image": "

The Docker image used to start the container.

", + "EksContainer$imagePullPolicy": "

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

", + "EksContainerDetail$name": "

The name of the container. If the name isn't specified, the default name \"Default\" is used. Each container in a pod must have a unique name.

", + "EksContainerDetail$image": "

The Docker image used to start the container.

", + "EksContainerDetail$imagePullPolicy": "

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

", + "EksContainerDetail$reason": "

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

", + "EksContainerEnvironmentVariable$name": "

The name of the environment variable.

", + "EksContainerEnvironmentVariable$value": "

The value of the environment variable.

", + "EksContainerOverride$image": "

The override of the Docker image that's used to start the container.

", + "EksContainerVolumeMount$name": "

The name the volume mount. This must match the name of one of the volumes in the pod.

", + "EksContainerVolumeMount$mountPath": "

The path on the container where the volume is mounted.

", + "EksEmptyDir$medium": "

The medium to store the volume. The default value is an empty string, which uses the storage of the node.

\"\"

(Default) Use the disk storage of the node.

\"Memory\"

Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit.

", + "EksHostPath$path": "

The path of the file or directory on the host to mount into containers on the pod.

", + "EksLimits$key": null, + "EksPodProperties$serviceAccountName": "

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

", + "EksPodProperties$dnsPolicy": "

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet | None

", + "EksPodPropertiesDetail$serviceAccountName": "

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

", + "EksPodPropertiesDetail$dnsPolicy": "

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet | None

", + "EksPodPropertiesDetail$podName": "

The name of the pod for this job.

", + "EksPodPropertiesDetail$nodeName": "

The name of the node for this job.

", + "EksRequests$key": null, + "EksSecret$secretName": "

The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

", + "EksVolume$name": "

The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

", + "EvaluateOnExit$onStatusReason": "

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

", + "EvaluateOnExit$onReason": "

Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

", + "EvaluateOnExit$onExitCode": "

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

", "FargatePlatformConfiguration$platformVersion": "

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

", - "Host$sourcePath": "

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.

", + "Host$sourcePath": "

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

", "JobDefinition$jobDefinitionName": "

The name of the job definition.

", "JobDefinition$jobDefinitionArn": "

The Amazon Resource Name (ARN) for the job definition.

", "JobDefinition$status": "

The status of the job definition.

", - "JobDefinition$type": "

The type of job definition, either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

", - "JobDependency$jobId": "

The job ID of the Batch job associated with this dependency.

", + "JobDefinition$type": "

The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

", + "JobDependency$jobId": "

The job ID of the Batch job that's associated with this dependency.

", "JobDetail$jobArn": "

The Amazon Resource Name (ARN) of the job.

", - "JobDetail$jobName": "

The name of the job.

", - "JobDetail$jobId": "

The ID for the job.

", + "JobDetail$jobName": "

The job name.

", + "JobDetail$jobId": "

The job ID.

", "JobDetail$jobQueue": "

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

", "JobDetail$shareIdentifier": "

The share identifier for the job.

", - "JobDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the job.

", - "JobDetail$jobDefinition": "

The Amazon Resource Name (ARN) of the job definition that's used by this job.

", - "JobQueueDetail$jobQueueName": "

The name of the job queue.

", + "JobDetail$statusReason": "

A short, human-readable string to provide more details for the current status of the job.

", + "JobDetail$jobDefinition": "

The Amazon Resource Name (ARN) of the job definition that this job uses.

", + "JobQueueDetail$jobQueueName": "

The job queue name.

", "JobQueueDetail$jobQueueArn": "

The Amazon Resource Name (ARN) of the job queue.

", - "JobQueueDetail$schedulingPolicyArn": "

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

", - "JobQueueDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the job queue.

", + "JobQueueDetail$schedulingPolicyArn": "

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

", + "JobQueueDetail$statusReason": "

A short, human-readable string to provide additional details for the current status of the job queue.

", "JobSummary$jobArn": "

The Amazon Resource Name (ARN) of the job.

", - "JobSummary$jobId": "

The ID of the job.

", - "JobSummary$jobName": "

The name of the job.

", - "JobSummary$statusReason": "

A short, human-readable string to provide additional details about the current status of the job.

", + "JobSummary$jobId": "

The job ID.

", + "JobSummary$jobName": "

The job name.

", + "JobSummary$statusReason": "

A short, human-readable string to provide more details for the current status of the job.

", "JobSummary$jobDefinition": "

The Amazon Resource Name (ARN) of the job definition.

", "KeyValuePair$name": "

The name of the key-value pair. For environment variables, this is the name of the environment variable.

", "KeyValuePair$value": "

The value of the key-value pair. For environment variables, this is the value of the environment variable.

", @@ -1035,11 +1289,11 @@ "ListJobsRequest$jobQueue": "

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

", "ListJobsRequest$arrayJobId": "

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

", "ListJobsRequest$multiNodeJobId": "

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

", - "ListJobsRequest$nextToken": "

The nextToken value returned from a previous paginated ListJobs 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.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

", + "ListJobsRequest$nextToken": "

The nextToken value returned from a previous paginated ListJobs 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 retrieve the next items in a list and not for other programmatic purposes.

", "ListJobsResponse$nextToken": "

The nextToken value to include in a future ListJobs request. When the results of a ListJobs 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.

", - "ListSchedulingPoliciesRequest$nextToken": "

The nextToken value that's returned from a previous paginated ListSchedulingPolicies 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.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

", + "ListSchedulingPoliciesRequest$nextToken": "

The nextToken value that's returned from a previous paginated ListSchedulingPolicies 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 retrieve the next items in a list and not for other programmatic purposes.

", "ListSchedulingPoliciesResponse$nextToken": "

The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies 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.

", - "ListTagsForResourceRequest$resourceArn": "

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, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "ListTagsForResourceRequest$resourceArn": "

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, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", "LogConfigurationOptionsMap$key": null, "LogConfigurationOptionsMap$value": null, "MountPoint$containerPath": "

The path on the container where the host volume is mounted.

", @@ -1048,57 +1302,57 @@ "NetworkInterface$ipv6Address": "

The private IPv6 address for the network interface.

", "NetworkInterface$privateIpv4Address": "

The private IPv4 address for the network interface.

", "NodePropertyOverride$targetNodes": "

The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range.

", - "NodeRangeProperty$targetNodes": "

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

", + "NodeRangeProperty$targetNodes": "

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.

", "ParametersMap$key": null, "ParametersMap$value": null, "RegisterJobDefinitionRequest$jobDefinitionName": "

The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "RegisterJobDefinitionResponse$jobDefinitionName": "

The name of the job definition.

", "RegisterJobDefinitionResponse$jobDefinitionArn": "

The Amazon Resource Name (ARN) of the job definition.

", - "ResourceRequirement$value": "

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type=\"GPU\"

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs are not available for jobs that are running on Fargate resources.
type=\"MEMORY\"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container 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 memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

VCPU = 2 or 4

value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

VCPU = 4

type=\"VCPU\"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

", + "ResourceRequirement$value": "

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type=\"GPU\"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.
type=\"MEMORY\"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container 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 memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

VCPU = 2 or 4

value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

VCPU = 4

type=\"VCPU\"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

", "SchedulingPolicyDetail$name": "

The name of the scheduling policy.

", "SchedulingPolicyDetail$arn": "

The Amazon Resource Name (ARN) of the scheduling policy. An example is arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority .

", "SchedulingPolicyListingDetail$arn": "

Amazon Resource Name (ARN) of the scheduling policy.

", "Secret$name": "

The name of the secret.

", - "Secret$valueFrom": "

The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

", + "Secret$valueFrom": "

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

", "ServerException$message": null, - "ShareAttributes$shareIdentifier": "

A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy cannot overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

There can be no more than 500 fair share identifiers active in a job queue.

The string is limited to 255 alphanumeric characters, optionally followed by an asterisk (*).

", + "ShareAttributes$shareIdentifier": "

A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

There can be no more than 500 fair share identifiers active in a job queue.

The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

", "StringList$member": null, "SubmitJobRequest$jobName": "

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "SubmitJobRequest$jobQueue": "

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

", - "SubmitJobRequest$shareIdentifier": "

The share identifier for the job. If the job queue does not have a scheduling policy, then this parameter must not be specified. If the job queue has a scheduling policy, then this parameter must be specified.

", + "SubmitJobRequest$shareIdentifier": "

The share identifier for the job. If the job queue doesn't have a scheduling policy, then this parameter must not be specified. If the job queue has a scheduling policy, then this parameter must be specified.

", "SubmitJobRequest$jobDefinition": "

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

", "SubmitJobResponse$jobArn": "

The Amazon Resource Name (ARN) for the job.

", "SubmitJobResponse$jobName": "

The name of the job.

", "SubmitJobResponse$jobId": "

The unique identifier for the job.

", - "TagResourceRequest$resourceArn": "

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, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "TagResourceRequest$resourceArn": "

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, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", "TagsMap$key": null, "TagsMap$value": null, "TerminateJobRequest$jobId": "

The Batch job ID of the job to terminate.

", "TerminateJobRequest$reason": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

", - "Tmpfs$containerPath": "

The absolute file path in the container where the tmpfs volume is mounted.

", + "Tmpfs$containerPath": "

The absolute file path in the container where the tmpfs volume is mounted.

", "Ulimit$name": "

The type of the ulimit.

", - "UntagResourceRequest$resourceArn": "

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, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "UntagResourceRequest$resourceArn": "

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, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", "UpdateComputeEnvironmentRequest$computeEnvironment": "

The name or full Amazon Resource Name (ARN) of the compute environment to update.

", "UpdateComputeEnvironmentRequest$serviceRole": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

If your specified role has a path other than /, then you must either specify 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 service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

", - "UpdateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", + "UpdateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "UpdateComputeEnvironmentResponse$computeEnvironmentArn": "

The Amazon Resource Name (ARN) of the compute environment.

", "UpdateJobQueueRequest$jobQueue": "

The name or the Amazon Resource Name (ARN) of the job queue.

", - "UpdateJobQueueRequest$schedulingPolicyArn": "

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

", + "UpdateJobQueueRequest$schedulingPolicyArn": "

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

", "UpdateJobQueueResponse$jobQueueName": "

The name of the job queue.

", "UpdateJobQueueResponse$jobQueueArn": "

The Amazon Resource Name (ARN) of the job queue.

", "UpdateSchedulingPolicyRequest$arn": "

The Amazon Resource Name (ARN) of the scheduling policy to update.

", - "Volume$name": "

The name of the volume. It can be up to 255 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

" + "Volume$name": "

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

" } }, "StringList": { "base": null, "refs": { - "ComputeResource$instanceTypes": "

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.

", + "ComputeResource$instanceTypes": "

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

", "ComputeResource$subnets": "

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide.

", - "ComputeResource$securityGroupIds": "

The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

", + "ComputeResource$securityGroupIds": "

The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

", "ComputeResourceUpdate$subnets": "

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

", - "ComputeResourceUpdate$securityGroupIds": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the security groups from the compute resource.

When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

", - "ComputeResourceUpdate$instanceTypes": "

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.

", + "ComputeResourceUpdate$securityGroupIds": "

The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the security groups from the compute resource.

When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

", + "ComputeResourceUpdate$instanceTypes": "

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

", "ContainerDetail$command": "

The command that's passed to the container.

", "ContainerOverrides$command": "

The command to send to the container that overrides the default command from the Docker image or the job definition.

", "ContainerProperties$command": "

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

", @@ -1107,8 +1361,14 @@ "DescribeJobQueuesRequest$jobQueues": "

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

", "DescribeJobsRequest$jobs": "

A list of up to 100 job IDs.

", "DescribeSchedulingPoliciesRequest$arns": "

A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

", + "EksContainer$command": "

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. 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 changed. For example, if the reference is to \"$(NAME1)\" and the NAME1 environment variable doesn't exist, the command string will remain \"$(NAME1).\" $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

", + "EksContainer$args": "

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod 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 changed. For example, if the reference is to \"$(NAME1)\" and the NAME1 environment variable doesn't exist, the command string will remain \"$(NAME1).\" $$ is replaced with $, and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

", + "EksContainerDetail$command": "

The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

", + "EksContainerDetail$args": "

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod 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 changed. For example, if the reference is to \"$(NAME1)\" and the NAME1 environment variable doesn't exist, the command string will remain \"$(NAME1)\". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

", + "EksContainerOverride$command": "

The command to send to the container that overrides the default command from the Docker image or the job definition.

", + "EksContainerOverride$args": "

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

", "KeyValuesPair$values": "

The filter values.

", - "Tmpfs$mountOptions": "

The list of tmpfs volume mount options.

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"

" + "Tmpfs$mountOptions": "

The list of tmpfs volume mount options.

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"

" } }, "SubmitJobRequest": { @@ -1157,9 +1417,9 @@ "CreateComputeEnvironmentRequest$tags": "

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

", "CreateJobQueueRequest$tags": "

The tags that you apply to the job queue 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 in Batch User Guide.

", "CreateSchedulingPolicyRequest$tags": "

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations.

", - "JobDefinition$tags": "

The tags applied to the job definition.

", - "JobDetail$tags": "

The tags applied to the job.

", - "JobQueueDetail$tags": "

The tags applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

", + "JobDefinition$tags": "

The tags that are applied to the job definition.

", + "JobDetail$tags": "

The tags that are applied to the job.

", + "JobQueueDetail$tags": "

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

", "ListTagsForResourceResponse$tags": "

The tags for the resource.

", "RegisterJobDefinitionRequest$tags": "

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

", "SchedulingPolicyDetail$tags": "

The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General Reference.

", @@ -1170,8 +1430,8 @@ "TagsMap": { "base": null, "refs": { - "ComputeResource$tags": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute environment. For more information, see Updating compute environments in the Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource API operation.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$tags": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource API operation.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

" + "ComputeResource$tags": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value-for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute environment. For more information, see Updating compute environments in the Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$tags": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value-for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource API operation.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

" } }, "TerminateJobRequest": { @@ -1185,7 +1445,7 @@ } }, "Tmpfs": { - "base": "

The container path, mount options, and size of the tmpfs mount.

This object isn't applicable to jobs that are running on Fargate resources.

", + "base": "

The container path, mount options, and size of the tmpfs mount.

This object isn't applicable to jobs that are running on Fargate resources.

", "refs": { "TmpfsList$member": null } @@ -1193,7 +1453,7 @@ "TmpfsList": { "base": null, "refs": { - "LinuxParameters$tmpfs": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

" + "LinuxParameters$tmpfs": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

" } }, "Ulimit": { @@ -1257,7 +1517,7 @@ } }, "Volume": { - "base": "

A data volume used in a job's container properties.

", + "base": "

A data volume that's used in a job's container properties.

", "refs": { "Volumes$member": null } @@ -1265,7 +1525,7 @@ "Volumes": { "base": null, "refs": { - "ContainerDetail$volumes": "

A list of volumes associated with the job.

", + "ContainerDetail$volumes": "

A list of volumes that are associated with the job.

", "ContainerProperties$volumes": "

A list of data volumes used in a job.

" } } diff --git a/models/apis/batch/2016-08-10/endpoint-rule-set-1.json b/models/apis/batch/2016-08-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000..cbc19ea87d --- /dev/null +++ b/models/apis/batch/2016-08-10/endpoint-rule-set-1.json @@ -0,0 +1,365 @@ +{ + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://fips.batch.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://batch.{Region}.{PartitionResult#dnsSuffix}", + "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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "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" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/batch/2016-08-10/endpoint-tests-1.json b/models/apis/batch/2016-08-10/endpoint-tests-1.json new file mode 100644 index 0000000000..8575da030b --- /dev/null +++ b/models/apis/batch/2016-08-10/endpoint-tests-1.json @@ -0,0 +1,1395 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "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": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "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": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "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": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "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": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "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": { + "UseFIPS": true, + "Region": "cn-north-1", + "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": { + "UseFIPS": true, + "Region": "cn-north-1", + "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": { + "UseFIPS": false, + "Region": "cn-north-1", + "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": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "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": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "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": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "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": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.batch.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://batch.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://batch.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "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": { + "UseFIPS": true, + "Region": "us-east-1", + "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": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/datasync/2018-11-09/api-2.json b/models/apis/datasync/2018-11-09/api-2.json index d5e1bc60b3..ccf792bea6 100644 --- a/models/apis/datasync/2018-11-09/api-2.json +++ b/models/apis/datasync/2018-11-09/api-2.json @@ -837,7 +837,8 @@ "AccessKey":{"shape":"ObjectStorageAccessKey"}, "SecretKey":{"shape":"ObjectStorageSecretKey"}, "AgentArns":{"shape":"AgentArnList"}, - "Tags":{"shape":"InputTagList"} + "Tags":{"shape":"InputTagList"}, + "ServerCertificate":{"shape":"ObjectStorageCertificate"} } }, "CreateLocationObjectStorageResponse":{ @@ -1118,7 +1119,8 @@ "ServerPort":{"shape":"ObjectStorageServerPort"}, "ServerProtocol":{"shape":"ObjectStorageServerProtocol"}, "AgentArns":{"shape":"AgentArnList"}, - "CreationTime":{"shape":"Time"} + "CreationTime":{"shape":"Time"}, + "ServerCertificate":{"shape":"ObjectStorageCertificate"} } }, "DescribeLocationS3Request":{ @@ -1179,7 +1181,8 @@ "FilesTransferred":{"shape":"long"}, "BytesWritten":{"shape":"long"}, "BytesTransferred":{"shape":"long"}, - "Result":{"shape":"TaskExecutionResultDetail"} + "Result":{"shape":"TaskExecutionResultDetail"}, + "BytesCompressed":{"shape":"long"} } }, "DescribeTaskRequest":{ @@ -1688,6 +1691,10 @@ "min":3, "pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" }, + "ObjectStorageCertificate":{ + "type":"blob", + "max":32768 + }, "ObjectStorageSecretKey":{ "type":"string", "max":200, @@ -2183,7 +2190,8 @@ "Subdirectory":{"shape":"S3Subdirectory"}, "AccessKey":{"shape":"ObjectStorageAccessKey"}, "SecretKey":{"shape":"ObjectStorageSecretKey"}, - "AgentArns":{"shape":"AgentArnList"} + "AgentArns":{"shape":"AgentArnList"}, + "ServerCertificate":{"shape":"ObjectStorageCertificate"} } }, "UpdateLocationObjectStorageResponse":{ diff --git a/models/apis/datasync/2018-11-09/docs-2.json b/models/apis/datasync/2018-11-09/docs-2.json index 583df38af3..dc0f283e5f 100644 --- a/models/apis/datasync/2018-11-09/docs-2.json +++ b/models/apis/datasync/2018-11-09/docs-2.json @@ -1,18 +1,18 @@ { "version": "2.0", - "service": "DataSync

DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).

This API interface reference for DataSync contains documentation for a programming interface that you can use to manage DataSync.

", + "service": "DataSync

DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.

This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .

", "operations": { - "CancelTaskExecution": "

Cancels execution of a task.

When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.

", - "CreateAgent": "

Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

", + "CancelTaskExecution": "

Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.

However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.

", + "CreateAgent": "

Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

", "CreateLocationEfs": "

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.

", "CreateLocationFsxLustre": "

Creates an endpoint for an Amazon FSx for Lustre file system.

", "CreateLocationFsxOntap": "

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.

", - "CreateLocationFsxOpenZfs": "

Creates an endpoint for an Amazon FSx for OpenZFS file system.

", + "CreateLocationFsxOpenZfs": "

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.

Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

", "CreateLocationFsxWindows": "

Creates an endpoint for an Amazon FSx for Windows File Server file system.

", "CreateLocationHdfs": "

Creates an endpoint for a Hadoop Distributed File System (HDFS).

", "CreateLocationNfs": "

Defines a file system on a Network File System (NFS) server that can be read from or written to.

", "CreateLocationObjectStorage": "

Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.

", - "CreateLocationS3": "

Creates an endpoint for an Amazon S3 bucket.

For more information, see Create an Amazon S3 location in the DataSync User Guide.

", + "CreateLocationS3": "

Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.

For more information, see Create an Amazon S3 location in the DataSync User Guide.

", "CreateLocationSmb": "

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

", "CreateTask": "

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync.

For more information, see the following topics:

", "DeleteAgent": "

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

", @@ -20,9 +20,9 @@ "DeleteTask": "

Deletes a task.

", "DescribeAgent": "

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

", "DescribeLocationEfs": "

Returns metadata about your DataSync location for an Amazon EFS file system.

", - "DescribeLocationFsxLustre": "

Returns metadata about an Amazon FSx for Lustre location, such as information about its path.

", - "DescribeLocationFsxOntap": "

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

", - "DescribeLocationFsxOpenZfs": "

Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.

", + "DescribeLocationFsxLustre": "

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

", + "DescribeLocationFsxOntap": "

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

", + "DescribeLocationFsxOpenZfs": "

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

", "DescribeLocationFsxWindows": "

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

", "DescribeLocationHdfs": "

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

", "DescribeLocationNfs": "

Returns metadata, such as the path information, about an NFS location.

", @@ -42,7 +42,7 @@ "UpdateAgent": "

Updates the name of an agent.

", "UpdateLocationHdfs": "

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

", "UpdateLocationNfs": "

Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.

", - "UpdateLocationObjectStorage": "

Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.

", + "UpdateLocationObjectStorage": "

Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.

", "UpdateLocationSmb": "

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.

", "UpdateTask": "

Updates the metadata associated with a task.

", "UpdateTaskExecution": "

Updates execution of a task.

You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.

The only Option that can be modified by UpdateTaskExecution is BytesPerSecond .

" @@ -79,7 +79,7 @@ "DescribeLocationSmbResponse$AgentArns": "

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

", "OnPremConfig$AgentArns": "

ARNs of the agents to use for an NFS location.

", "UpdateLocationHdfsRequest$AgentArns": "

The ARNs of the agents that are used to connect to the HDFS cluster.

", - "UpdateLocationObjectStorageRequest$AgentArns": "

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

", + "UpdateLocationObjectStorageRequest$AgentArns": "

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

", "UpdateLocationSmbRequest$AgentArns": "

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

" } }, @@ -503,8 +503,8 @@ "refs": { "CreateTaskRequest$Excludes": "

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

", "CreateTaskRequest$Includes": "

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

", - "DescribeTaskExecutionResponse$Excludes": "

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

", - "DescribeTaskExecutionResponse$Includes": "

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

", + "DescribeTaskExecutionResponse$Excludes": "

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

", + "DescribeTaskExecutionResponse$Includes": "

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

", "DescribeTaskResponse$Excludes": "

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

", "DescribeTaskResponse$Includes": "

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

", "StartTaskExecutionRequest$Includes": "

A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

", @@ -832,7 +832,7 @@ "LocationListEntry$LocationArn": "

The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

", "UpdateLocationHdfsRequest$LocationArn": "

The Amazon Resource Name (ARN) of the source HDFS cluster location.

", "UpdateLocationNfsRequest$LocationArn": "

The Amazon Resource Name (ARN) of the NFS location to update.

", - "UpdateLocationObjectStorageRequest$LocationArn": "

The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.

", + "UpdateLocationObjectStorageRequest$LocationArn": "

Specifies the ARN of the object storage system location that you're updating.

", "UpdateLocationSmbRequest$LocationArn": "

The Amazon Resource Name (ARN) of the SMB location to update.

" } }, @@ -960,8 +960,8 @@ "base": null, "refs": { "CreateLocationObjectStorageRequest$AccessKey": "

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

", - "DescribeLocationObjectStorageResponse$AccessKey": "

The access key (for example, a user name) required to authenticate with the object storage server.

", - "UpdateLocationObjectStorageRequest$AccessKey": "

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

" + "DescribeLocationObjectStorageResponse$AccessKey": "

The access key (for example, a user name) required to authenticate with the object storage system.

", + "UpdateLocationObjectStorageRequest$AccessKey": "

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

" } }, "ObjectStorageBucketName": { @@ -970,11 +970,19 @@ "CreateLocationObjectStorageRequest$BucketName": "

Specifies the name of the object storage bucket involved in the transfer.

" } }, + "ObjectStorageCertificate": { + "base": null, + "refs": { + "CreateLocationObjectStorageRequest$ServerCertificate": "

Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

", + "DescribeLocationObjectStorageResponse$ServerCertificate": "

The self-signed certificate that DataSync uses to securely authenticate with your object storage system.

", + "UpdateLocationObjectStorageRequest$ServerCertificate": "

Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

Updating the certificate doesn't interfere with tasks that you have in progress.

" + } + }, "ObjectStorageSecretKey": { "base": null, "refs": { "CreateLocationObjectStorageRequest$SecretKey": "

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

", - "UpdateLocationObjectStorageRequest$SecretKey": "

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

" + "UpdateLocationObjectStorageRequest$SecretKey": "

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

" } }, "ObjectStorageServerPort": { @@ -982,15 +990,15 @@ "refs": { "CreateLocationObjectStorageRequest$ServerPort": "

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

", "DescribeLocationObjectStorageResponse$ServerPort": "

The port that your object storage server accepts inbound network traffic on (for example, port 443).

", - "UpdateLocationObjectStorageRequest$ServerPort": "

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

" + "UpdateLocationObjectStorageRequest$ServerPort": "

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

" } }, "ObjectStorageServerProtocol": { "base": null, "refs": { "CreateLocationObjectStorageRequest$ServerProtocol": "

Specifies the protocol that your object storage server uses to communicate.

", - "DescribeLocationObjectStorageResponse$ServerProtocol": "

The protocol that your object storage server uses to communicate.

", - "UpdateLocationObjectStorageRequest$ServerProtocol": "

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

" + "DescribeLocationObjectStorageResponse$ServerProtocol": "

The protocol that your object storage system uses to communicate.

", + "UpdateLocationObjectStorageRequest$ServerProtocol": "

Specifies the protocol that your object storage server uses to communicate.

" } }, "ObjectTags": { @@ -1116,7 +1124,7 @@ "refs": { "CreateLocationObjectStorageRequest$Subdirectory": "

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

", "CreateLocationS3Request$Subdirectory": "

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

", - "UpdateLocationObjectStorageRequest$Subdirectory": "

The subdirectory in the self-managed object storage server that is used to read data from.

" + "UpdateLocationObjectStorageRequest$Subdirectory": "

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

" } }, "ScheduleExpressionCron": { @@ -1283,7 +1291,7 @@ "TaskExecutionArn": { "base": null, "refs": { - "CancelTaskExecutionRequest$TaskExecutionArn": "

The Amazon Resource Name (ARN) of the task execution to cancel.

", + "CancelTaskExecutionRequest$TaskExecutionArn": "

The Amazon Resource Name (ARN) of the task execution to stop.

", "DescribeTaskExecutionRequest$TaskExecutionArn": "

The Amazon Resource Name (ARN) of the task that is being executed.

", "DescribeTaskExecutionResponse$TaskExecutionArn": "

The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

", "DescribeTaskResponse$CurrentTaskExecutionArn": "

The Amazon Resource Name (ARN) of the task execution that is syncing files.

", @@ -1499,7 +1507,8 @@ "DescribeTaskExecutionResponse$EstimatedBytesToTransfer": "

The estimated physical number of bytes that is to be transferred over the network.

", "DescribeTaskExecutionResponse$FilesTransferred": "

The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.

If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

", "DescribeTaskExecutionResponse$BytesWritten": "

The number of logical bytes written to the destination Amazon Web Services storage resource.

", - "DescribeTaskExecutionResponse$BytesTransferred": "

The physical number of bytes transferred over the network.

" + "DescribeTaskExecutionResponse$BytesTransferred": "

The physical number of bytes transferred over the network.

", + "DescribeTaskExecutionResponse$BytesCompressed": "

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred.

" } }, "string": { diff --git a/models/apis/datasync/2018-11-09/endpoint-rule-set-1.json b/models/apis/datasync/2018-11-09/endpoint-rule-set-1.json new file mode 100644 index 0000000000..d3a4482d52 --- /dev/null +++ b/models/apis/datasync/2018-11-09/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://datasync-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://datasync-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://datasync.{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://datasync.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/datasync/2018-11-09/endpoint-tests-1.json b/models/apis/datasync/2018-11-09/endpoint-tests-1.json new file mode 100644 index 0000000000..7ecda16f4f --- /dev/null +++ b/models/apis/datasync/2018-11-09/endpoint-tests-1.json @@ -0,0 +1,1543 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datasync.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "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": { + "UseFIPS": true, + "Region": "us-east-1", + "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": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index 2125d9fccc..ec5771238c 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -1992,6 +1992,15 @@ "input":{"shape":"ListImagesRequest"}, "output":{"shape":"ListImagesResponse"} }, + "ListInferenceRecommendationsJobSteps":{ + "name":"ListInferenceRecommendationsJobSteps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInferenceRecommendationsJobStepsRequest"}, + "output":{"shape":"ListInferenceRecommendationsJobStepsResponse"} + }, "ListInferenceRecommendationsJobs":{ "name":"ListInferenceRecommendationsJobs", "http":{ @@ -3821,7 +3830,8 @@ "PrecisionMacro", "Recall", "RecallMacro", - "LogLoss" + "LogLoss", + "InferenceLatency" ] }, "AutoMLMode":{ @@ -10427,6 +10437,24 @@ "FailureReason":{"shape":"FailureReason"} } }, + "InferenceRecommendationsJobStep":{ + "type":"structure", + "required":[ + "StepType", + "JobName", + "Status" + ], + "members":{ + "StepType":{"shape":"RecommendationStepType"}, + "JobName":{"shape":"RecommendationJobName"}, + "Status":{"shape":"RecommendationJobStatus"}, + "InferenceBenchmark":{"shape":"RecommendationJobInferenceBenchmark"} + } + }, + "InferenceRecommendationsJobSteps":{ + "type":"list", + "member":{"shape":"InferenceRecommendationsJobStep"} + }, "InferenceRecommendationsJobs":{ "type":"list", "member":{"shape":"InferenceRecommendationsJob"} @@ -11609,6 +11637,24 @@ "NextToken":{"shape":"NextToken"} } }, + "ListInferenceRecommendationsJobStepsRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{"shape":"RecommendationJobName"}, + "Status":{"shape":"RecommendationJobStatus"}, + "StepType":{"shape":"RecommendationStepType"}, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListInferenceRecommendationsJobStepsResponse":{ + "type":"structure", + "members":{ + "Steps":{"shape":"InferenceRecommendationsJobSteps"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListInferenceRecommendationsJobsRequest":{ "type":"structure", "members":{ @@ -15110,6 +15156,7 @@ "type":"list", "member":{"shape":"ProductionVariantInstanceType"} }, + "RecommendationFailureReason":{"type":"string"}, "RecommendationJobArn":{ "type":"string", "max":256, @@ -15137,6 +15184,16 @@ "type":"string", "max":128 }, + "RecommendationJobInferenceBenchmark":{ + "type":"structure", + "required":["ModelConfiguration"], + "members":{ + "Metrics":{"shape":"RecommendationMetrics"}, + "EndpointConfiguration":{"shape":"EndpointOutputConfiguration"}, + "ModelConfiguration":{"shape":"ModelConfiguration"}, + "FailureReason":{"shape":"RecommendationFailureReason"} + } + }, "RecommendationJobInputConfig":{ "type":"structure", "required":["ModelPackageVersionArn"], @@ -15226,6 +15283,10 @@ "ModelLatency":{"shape":"Integer"} } }, + "RecommendationStepType":{ + "type":"string", + "enum":["BENCHMARK"] + }, "RecordWrapper":{ "type":"string", "enum":[ diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index a1c1736d28..4be79c7670 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -180,6 +180,7 @@ "ListHyperParameterTuningJobs": "

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

", "ListImageVersions": "

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

", "ListImages": "

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

", + "ListInferenceRecommendationsJobSteps": "

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

", "ListInferenceRecommendationsJobs": "

Lists recommendation jobs that satisfy various filters.

", "ListLabelingJobs": "

Gets a list of labeling jobs.

", "ListLabelingJobsForWorkteam": "

Gets a list of labeling jobs assigned to a specified work team.

", @@ -4256,7 +4257,8 @@ "EndpointOutputConfiguration": { "base": "

The endpoint configuration made by Inference Recommender during a recommendation job.

", "refs": { - "InferenceRecommendation$EndpointConfiguration": "

Defines the endpoint configuration parameters.

" + "InferenceRecommendation$EndpointConfiguration": "

Defines the endpoint configuration parameters.

", + "RecommendationJobInferenceBenchmark$EndpointConfiguration": null } }, "EndpointPerformance": { @@ -5754,6 +5756,18 @@ "InferenceRecommendationsJobs$member": null } }, + "InferenceRecommendationsJobStep": { + "base": "

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

", + "refs": { + "InferenceRecommendationsJobSteps$member": null + } + }, + "InferenceRecommendationsJobSteps": { + "base": null, + "refs": { + "ListInferenceRecommendationsJobStepsResponse$Steps": "

A list of all subtask details in Inference Recommender.

" + } + }, "InferenceRecommendationsJobs": { "base": null, "refs": { @@ -6633,6 +6647,16 @@ "refs": { } }, + "ListInferenceRecommendationsJobStepsRequest": { + "base": null, + "refs": { + } + }, + "ListInferenceRecommendationsJobStepsResponse": { + "base": null, + "refs": { + } + }, "ListInferenceRecommendationsJobsRequest": { "base": null, "refs": { @@ -7137,6 +7161,7 @@ "ListHyperParameterTuningJobsRequest$MaxResults": "

The maximum number of tuning jobs to return. The default value is 10.

", "ListImageVersionsRequest$MaxResults": "

The maximum number of versions to return in the response. The default value is 10.

", "ListImagesRequest$MaxResults": "

The maximum number of images to return in the response. The default value is 10.

", + "ListInferenceRecommendationsJobStepsRequest$MaxResults": "

The maximum number of results to return.

", "ListInferenceRecommendationsJobsRequest$MaxResults": "

The maximum number of recommendations to return in the response.

", "ListLabelingJobsForWorkteamRequest$MaxResults": "

The maximum number of labeling jobs to return in each page of the response.

", "ListLabelingJobsRequest$MaxResults": "

The maximum number of labeling jobs to return in each page of the response.

", @@ -7403,7 +7428,8 @@ "ModelConfiguration": { "base": "

Defines the model configuration. Includes the specification name and environment parameters.

", "refs": { - "InferenceRecommendation$ModelConfiguration": "

Defines the model configuration.

" + "InferenceRecommendation$ModelConfiguration": "

Defines the model configuration.

", + "RecommendationJobInferenceBenchmark$ModelConfiguration": null } }, "ModelDataQuality": { @@ -8282,6 +8308,8 @@ "ListImageVersionsResponse$NextToken": "

A token for getting the next set of versions, if there are any.

", "ListImagesRequest$NextToken": "

If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

", "ListImagesResponse$NextToken": "

A token for getting the next set of images, if there are any.

", + "ListInferenceRecommendationsJobStepsRequest$NextToken": "

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

", + "ListInferenceRecommendationsJobStepsResponse$NextToken": "

A token that you can specify in your next request to return more results from the list.

", "ListInferenceRecommendationsJobsRequest$NextToken": "

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

", "ListInferenceRecommendationsJobsResponse$NextToken": "

A token for getting the next set of recommendations, if there are any.

", "ListLabelingJobsForWorkteamRequest$NextToken": "

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", @@ -9731,6 +9759,12 @@ "InferenceSpecification$SupportedRealtimeInferenceInstanceTypes": "

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

" } }, + "RecommendationFailureReason": { + "base": null, + "refs": { + "RecommendationJobInferenceBenchmark$FailureReason": "

The reason why a benchmark failed.

" + } + }, "RecommendationJobArn": { "base": null, "refs": { @@ -9759,6 +9793,12 @@ "InferenceRecommendationsJob$JobDescription": "

The job description.

" } }, + "RecommendationJobInferenceBenchmark": { + "base": "

The details for a specific benchmark from an Inference Recommender job.

", + "refs": { + "InferenceRecommendationsJobStep$InferenceBenchmark": "

The details for a specific benchmark.

" + } + }, "RecommendationJobInputConfig": { "base": "

The input configuration of the recommendation job.

", "refs": { @@ -9773,6 +9813,8 @@ "DescribeInferenceRecommendationsJobRequest$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", "DescribeInferenceRecommendationsJobResponse$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", "InferenceRecommendationsJob$JobName": "

The name of the job.

", + "InferenceRecommendationsJobStep$JobName": "

The name of the Inference Recommender job.

", + "ListInferenceRecommendationsJobStepsRequest$JobName": "

The name for the Inference Recommender job.

", "StopInferenceRecommendationsJobRequest$JobName": "

The name of the job you want to stop.

" } }, @@ -9799,6 +9841,8 @@ "refs": { "DescribeInferenceRecommendationsJobResponse$Status": "

The status of the job.

", "InferenceRecommendationsJob$Status": "

The status of the job.

", + "InferenceRecommendationsJobStep$Status": "

The current status of the benchmark.

", + "ListInferenceRecommendationsJobStepsRequest$Status": "

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

", "ListInferenceRecommendationsJobsRequest$StatusEquals": "

A filter that retrieves only inference recommendations jobs with a specific status.

" } }, @@ -9832,7 +9876,15 @@ "RecommendationMetrics": { "base": "

The metrics of recommendations.

", "refs": { - "InferenceRecommendation$Metrics": "

The metrics used to decide what recommendation to make.

" + "InferenceRecommendation$Metrics": "

The metrics used to decide what recommendation to make.

", + "RecommendationJobInferenceBenchmark$Metrics": null + } + }, + "RecommendationStepType": { + "base": null, + "refs": { + "InferenceRecommendationsJobStep$StepType": "

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

", + "ListInferenceRecommendationsJobStepsRequest$StepType": "

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

" } }, "RecordWrapper": { diff --git a/models/apis/sagemaker/2017-07-24/paginators-1.json b/models/apis/sagemaker/2017-07-24/paginators-1.json index 95cc031011..ab5e61c1d5 100644 --- a/models/apis/sagemaker/2017-07-24/paginators-1.json +++ b/models/apis/sagemaker/2017-07-24/paginators-1.json @@ -156,6 +156,12 @@ "limit_key": "MaxResults", "result_key": "Images" }, + "ListInferenceRecommendationsJobSteps": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Steps" + }, "ListInferenceRecommendationsJobs": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 6b7d0d43a3..7ecb82d25d 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -8009,6 +8009,13 @@ "deprecated" : true, "hostname" : "kms-fips.ap-south-1.amazonaws.com" }, + "ap-south-2-fips" : { + "credentialScope" : { + "region" : "ap-south-2" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-south-2.amazonaws.com" + }, "ap-southeast-1" : { "variants" : [ { "hostname" : "kms-fips.ap-southeast-1.amazonaws.com", diff --git a/service/acmpca/api.go b/service/acmpca/api.go index cd3f373da6..5c0c6d2b7b 100644 --- a/service/acmpca/api.go +++ b/service/acmpca/api.go @@ -3196,6 +3196,14 @@ type CertificateAuthority struct { // Type of your private CA. Type *string `type:"string" enum:"CertificateAuthorityType"` + + // Specifies whether the CA issues general-purpose certificates that typically + // require a revocation mechanism, or short-lived certificates that may optionally + // omit revocation because they expire quickly. Short-lived certificate validity + // is limited to seven days. + // + // The default value is GENERAL_PURPOSE. + UsageMode *string `type:"string" enum:"CertificateAuthorityUsageMode"` } // String returns the string representation. @@ -3300,6 +3308,12 @@ func (s *CertificateAuthority) SetType(v string) *CertificateAuthority { return s } +// SetUsageMode sets the UsageMode field's value. +func (s *CertificateAuthority) SetUsageMode(v string) *CertificateAuthority { + s.UsageMode = &v + return s +} + // Contains configuration information for your private certificate authority // (CA). This includes information about the class of public key algorithm and // the key pair that your private CA creates when it issues a certificate. It @@ -3710,6 +3724,14 @@ type CreateCertificateAuthorityInput struct { // up to 50 tags with a private CA. For information using tags with IAM to manage // permissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags []*Tag `min:"1" type:"list"` + + // Specifies whether the CA issues general-purpose certificates that typically + // require a revocation mechanism, or short-lived certificates that may optionally + // omit revocation because they expire quickly. Short-lived certificate validity + // is limited to seven days. + // + // The default value is GENERAL_PURPOSE. + UsageMode *string `type:"string" enum:"CertificateAuthorityUsageMode"` } // String returns the string representation. @@ -3808,6 +3830,12 @@ func (s *CreateCertificateAuthorityInput) SetTags(v []*Tag) *CreateCertificateAu return s } +// SetUsageMode sets the UsageMode field's value. +func (s *CreateCertificateAuthorityInput) SetUsageMode(v string) *CreateCertificateAuthorityInput { + s.UsageMode = &v + return s +} + type CreateCertificateAuthorityOutput struct { _ struct{} `type:"structure"` @@ -4020,7 +4048,7 @@ func (s CreatePermissionOutput) GoString() string { // openssl crl -inform DER -text -in crl_path -noout // // For more information, see Planning a certificate revocation list (CRL) (https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html) -// in the Certificate Manager Private Certificate Authority (PCA) User Guide +// in the Private Certificate Authority (PCA) User Guide type CrlConfiguration struct { _ struct{} `type:"structure"` @@ -7128,7 +7156,7 @@ type OcspConfiguration struct { // // For more information, see Customizing Online Certificate Status Protocol // (OCSP) (https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html) - // in the Certificate Manager Private Certificate Authority (PCA) User Guide. + // in the Private Certificate Authority (PCA) User Guide. OcspCustomCname *string `type:"string"` } @@ -8015,7 +8043,7 @@ func (s RestoreCertificateAuthorityOutput) GoString() string { // by clients, and a CRL contains an updated list of certificates revoked by // your CA. For more information, see RevokeCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html) // and Setting up a certificate revocation method (https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html) -// in the Certificate Manager Private Certificate Authority (PCA) User Guide. +// in the Private Certificate Authority (PCA) User Guide. type RevocationConfiguration struct { _ struct{} `type:"structure"` @@ -8632,7 +8660,7 @@ func (s UpdateCertificateAuthorityOutput) GoString() string { // Validity specifies the period of time during which a certificate is valid. // Validity can be expressed as an explicit date and time when the validity // of a certificate starts or expires, or as a span of time after issuance, -// stated in days, months, or years. For more information, see Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5) +// stated in days, months, or years. For more information, see Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) // in RFC 5280. // // ACM Private CA API consumes the Validity data type differently in two distinct @@ -8863,6 +8891,22 @@ func CertificateAuthorityType_Values() []string { } } +const ( + // CertificateAuthorityUsageModeGeneralPurpose is a CertificateAuthorityUsageMode enum value + CertificateAuthorityUsageModeGeneralPurpose = "GENERAL_PURPOSE" + + // CertificateAuthorityUsageModeShortLivedCertificate is a CertificateAuthorityUsageMode enum value + CertificateAuthorityUsageModeShortLivedCertificate = "SHORT_LIVED_CERTIFICATE" +) + +// CertificateAuthorityUsageMode_Values returns all elements of the CertificateAuthorityUsageMode enum +func CertificateAuthorityUsageMode_Values() []string { + return []string{ + CertificateAuthorityUsageModeGeneralPurpose, + CertificateAuthorityUsageModeShortLivedCertificate, + } +} + const ( // ExtendedKeyUsageTypeServerAuth is a ExtendedKeyUsageType enum value ExtendedKeyUsageTypeServerAuth = "SERVER_AUTH" diff --git a/service/acmpca/doc.go b/service/acmpca/doc.go index 261e71a2b8..105c18b987 100644 --- a/service/acmpca/doc.go +++ b/service/acmpca/doc.go @@ -3,10 +3,10 @@ // Package acmpca provides the client and types for making API // requests to AWS Certificate Manager Private Certificate Authority. // -// This is the Certificate Manager Private Certificate Authority (PCA) API Reference. -// It provides descriptions, syntax, and usage examples for each of the actions -// and data types involved in creating and managing a private certificate authority -// (CA) for your organization. +// This is the Private Certificate Authority (PCA) API Reference. It provides +// descriptions, syntax, and usage examples for each of the actions and data +// types involved in creating and managing a private certificate authority (CA) +// for your organization. // // The documentation for each action shows the API request parameters and the // JSON response. Alternatively, you can use one of the Amazon Web Services diff --git a/service/batch/api.go b/service/batch/api.go index 82fed6cb4a..15b43c22c6 100644 --- a/service/batch/api.go +++ b/service/batch/api.go @@ -57,9 +57,9 @@ func (c *Batch) CancelJobRequest(input *CancelJobInput) (req *request.Request, o // CancelJob API operation for AWS Batch. // // Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, -// or RUNNABLE state are canceled. Jobs that have progressed to STARTING or -// RUNNING aren't canceled, but the API operation still succeeds, even if no -// job is canceled. These jobs must be terminated with the TerminateJob operation. +// or RUNNABLE state are canceled. Jobs that progressed to the STARTING or RUNNING +// state aren't canceled. However, the API operation still succeeds, even if +// no job is canceled. These jobs must be terminated with the TerminateJob operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -71,9 +71,10 @@ func (c *Batch) CancelJobRequest(input *CancelJobInput) (req *request.Request, o // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -160,10 +161,10 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // Multi-node parallel jobs aren't supported on Spot Instances. // // In an unmanaged compute environment, you can manage your own EC2 compute -// resources and have a lot of flexibility with how you configure your compute -// resources. For example, you can use custom AMIs. However, you must verify -// that each of your AMIs meet the Amazon ECS container instance AMI specification. -// For more information, see container instance AMIs (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) +// resources and have flexibility with how you configure your compute resources. +// For example, you can use custom AMIs. However, you must verify that each +// of your AMIs meet the Amazon ECS container instance AMI specification. For +// more information, see container instance AMIs (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) // in the Amazon Elastic Container Service Developer Guide. After you created // your unmanaged compute environment, you can use the DescribeComputeEnvironments // operation to find the Amazon ECS cluster that's associated with it. Then, @@ -193,7 +194,7 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // To use the enhanced updating of compute environments to update AMIs, follow // these rules: // -// - Either do not set the service role (serviceRole) parameter or set it +// - Either don't set the service role (serviceRole) parameter or set it // to the AWSBatchServiceRole service-linked role. // // - Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE @@ -202,26 +203,26 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // - Set the update to latest image version (updateToLatestImageVersion) // parameter to true. // -// - Do not specify an AMI ID in imageId, imageIdOverride (in ec2Configuration +// - Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration // (https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html)), -// or in the launch template (launchTemplate). In that case Batch will select -// the latest Amazon ECS optimized AMI supported by Batch at the time the -// infrastructure update is initiated. Alternatively you can specify the -// AMI ID in the imageId or imageIdOverride parameters, or the launch template -// identified by the LaunchTemplate properties. Changing any of these properties -// will trigger an infrastructure update. If the AMI ID is specified in the -// launch template, it can not be replaced by specifying an AMI ID in either -// the imageId or imageIdOverride parameters. It can only be replaced by -// specifying a different launch template, or if the launch template version +// or in the launch template (launchTemplate). In that case, Batch selects +// the latest Amazon ECS optimized AMI that's supported by Batch at the time +// the infrastructure update is initiated. Alternatively, you can specify +// the AMI ID in the imageId or imageIdOverride parameters, or the launch +// template identified by the LaunchTemplate properties. Changing any of +// these properties starts an infrastructure update. If the AMI ID is specified +// in the launch template, it can't be replaced by specifying an AMI ID in +// either the imageId or imageIdOverride parameters. It can only be replaced +// by specifying a different launch template, or if the launch template version // is set to $Default or $Latest, by setting either a new default version -// for the launch template (if $Default)or by adding a new version to the +// for the launch template (if $Default) or by adding a new version to the // launch template (if $Latest). // -// If these rules are followed, any update that triggers an infrastructure update -// will cause the AMI ID to be re-selected. If the version setting in the launch +// If these rules are followed, any update that starts an infrastructure update +// causes the AMI ID to be re-selected. If the version setting in the launch // template (launchTemplate) is set to $Latest or $Default, the latest or default -// version of the launch template will be evaluated up at the time of the infrastructure -// update, even if the launchTemplate was not updated. +// version of the launch template is evaluated up at the time of the infrastructure +// update, even if the launchTemplate wasn't updated. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -233,9 +234,10 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -325,9 +327,10 @@ func (c *Batch) CreateJobQueueRequest(input *CreateJobQueueInput) (req *request. // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -409,9 +412,10 @@ func (c *Batch) CreateSchedulingPolicyRequest(input *CreateSchedulingPolicyInput // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -501,9 +505,10 @@ func (c *Batch) DeleteComputeEnvironmentRequest(input *DeleteComputeEnvironmentI // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -592,9 +597,10 @@ func (c *Batch) DeleteJobQueueRequest(input *DeleteJobQueueInput) (req *request. // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -679,9 +685,10 @@ func (c *Batch) DeleteSchedulingPolicyRequest(input *DeleteSchedulingPolicyInput // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -765,9 +772,10 @@ func (c *Batch) DeregisterJobDefinitionRequest(input *DeregisterJobDefinitionInp // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -859,9 +867,10 @@ func (c *Batch) DescribeComputeEnvironmentsRequest(input *DescribeComputeEnviron // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1001,9 +1010,10 @@ func (c *Batch) DescribeJobDefinitionsRequest(input *DescribeJobDefinitionsInput // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1142,9 +1152,10 @@ func (c *Batch) DescribeJobQueuesRequest(input *DescribeJobQueuesInput) (req *re // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1277,9 +1288,10 @@ func (c *Batch) DescribeJobsRequest(input *DescribeJobsInput) (req *request.Requ // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1361,9 +1373,10 @@ func (c *Batch) DescribeSchedulingPoliciesRequest(input *DescribeSchedulingPolic // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1462,9 +1475,10 @@ func (c *Batch) ListJobsRequest(input *ListJobsInput) (req *request.Request, out // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1603,9 +1617,10 @@ func (c *Batch) ListSchedulingPoliciesRequest(input *ListSchedulingPoliciesInput // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1728,7 +1743,7 @@ func (c *Batch) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req // // Lists the tags for an Batch resource. Batch resources that support tags are // compute environments, jobs, job definitions, job queues, and scheduling policies. -// ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported. +// ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1740,9 +1755,10 @@ func (c *Batch) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1824,9 +1840,10 @@ func (c *Batch) RegisterJobDefinitionRequest(input *RegisterJobDefinitionInput) // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -1921,9 +1938,10 @@ func (c *Batch) SubmitJobRequest(input *SubmitJobInput) (req *request.Request, o // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2000,7 +2018,7 @@ func (c *Batch) TagResourceRequest(input *TagResourceInput) (req *request.Reques // with that resource are deleted as well. Batch resources that support tags // are compute environments, jobs, job definitions, job queues, and scheduling // policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs -// are not supported. +// aren't supported. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2012,9 +2030,10 @@ func (c *Batch) TagResourceRequest(input *TagResourceInput) (req *request.Reques // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2099,9 +2118,10 @@ func (c *Batch) TerminateJobRequest(input *TerminateJobInput) (req *request.Requ // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2184,9 +2204,10 @@ func (c *Batch) UntagResourceRequest(input *UntagResourceInput) (req *request.Re // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2268,9 +2289,10 @@ func (c *Batch) UpdateComputeEnvironmentRequest(input *UpdateComputeEnvironmentI // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2352,9 +2374,10 @@ func (c *Batch) UpdateJobQueueRequest(input *UpdateJobQueueInput) (req *request. // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2437,9 +2460,10 @@ func (c *Batch) UpdateSchedulingPolicyRequest(input *UpdateSchedulingPolicyInput // Returned Error Types: // // - ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. // // - ServerException // These errors are usually caused by a server issue. @@ -2466,7 +2490,7 @@ func (c *Batch) UpdateSchedulingPolicyWithContext(ctx aws.Context, input *Update return out, req.Send() } -// An object representing an Batch array job. +// An object that represents an Batch array job. type ArrayProperties struct { _ struct{} `type:"structure"` @@ -2498,7 +2522,7 @@ func (s *ArrayProperties) SetSize(v int64) *ArrayProperties { return s } -// An object representing the array properties of a job. +// An object that represents the array properties of a job. type ArrayPropertiesDetail struct { _ struct{} `type:"structure"` @@ -2550,7 +2574,7 @@ func (s *ArrayPropertiesDetail) SetStatusSummary(v map[string]*int64) *ArrayProp return s } -// An object representing the array properties of a job. +// An object that represents the array properties of a job. type ArrayPropertiesSummary struct { _ struct{} `type:"structure"` @@ -2592,7 +2616,8 @@ func (s *ArrayPropertiesSummary) SetSize(v int64) *ArrayPropertiesSummary { return s } -// An object representing the details of a container that's part of a job attempt. +// An object that represents the details of a container that's part of a job +// attempt. type AttemptContainerDetail struct { _ struct{} `type:"structure"` @@ -2600,19 +2625,19 @@ type AttemptContainerDetail struct { // hosts the job attempt. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` - // The exit code for the job attempt. A non-zero exit code is considered a failure. + // The exit code for the job attempt. A non-zero exit code is considered failed. ExitCode *int64 `locationName:"exitCode" type:"integer"` - // The name of the CloudWatch Logs log stream associated with the container. + // The name of the CloudWatch Logs log stream that's associated with the container. // The log group for Batch jobs is /aws/batch/job. Each container attempt receives // a log stream name when they reach the RUNNING status. LogStreamName *string `locationName:"logStreamName" type:"string"` - // The network interfaces associated with the job attempt. + // The network interfaces that are associated with the job attempt. NetworkInterfaces []*NetworkInterface `locationName:"networkInterfaces" type:"list"` // A short (255 max characters) human-readable string to provide additional - // details about a running or stopped container. + // details for a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with @@ -2675,18 +2700,18 @@ func (s *AttemptContainerDetail) SetTaskArn(v string) *AttemptContainerDetail { return s } -// An object representing a job attempt. +// An object that represents a job attempt. type AttemptDetail struct { _ struct{} `type:"structure"` - // Details about the container in this job attempt. + // The details for the container in this job attempt. Container *AttemptContainerDetail `locationName:"container" type:"structure"` // The Unix timestamp (in milliseconds) for when the attempt was started (when // the attempt transitioned from the STARTING state to the RUNNING state). StartedAt *int64 `locationName:"startedAt" type:"long"` - // A short, human-readable string to provide additional details about the current + // A short, human-readable string to provide additional details for the current // status of the job attempt. StatusReason *string `locationName:"statusReason" type:"string"` @@ -2823,9 +2848,10 @@ func (s CancelJobOutput) GoString() string { return s.String() } -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that's not valid. +// These errors are usually caused by a client action. One example cause is +// using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource. Another cause is specifying an identifier +// that's not valid. type ClientException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2889,7 +2915,7 @@ func (s *ClientException) RequestID() string { return s.RespMetadata.RequestID } -// An object representing an Batch compute environment. +// An object that represents an Batch compute environment. type ComputeEnvironmentDetail struct { _ struct{} `type:"structure"` @@ -2898,9 +2924,9 @@ type ComputeEnvironmentDetail struct { // ComputeEnvironmentArn is a required field ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string" required:"true"` - // The name of the compute environment. It can be up to 128 letters long. It - // can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores - // (_). + // The name of the compute environment. It can be up to 128 characters long. + // It can contain uppercase and lowercase letters, numbers, hyphens (-), and + // underscores (_). // // ComputeEnvironmentName is a required field ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string" required:"true"` @@ -2910,13 +2936,22 @@ type ComputeEnvironmentDetail struct { // in the Batch User Guide. ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"` - // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used - // by the compute environment. + // The orchestration type of the compute environment. The valid values are ECS + // (default) or EKS. + ContainerOrchestrationType *string `locationName:"containerOrchestrationType" type:"string" enum:"OrchestrationType"` + + // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that + // the compute environment uses. EcsClusterArn *string `locationName:"ecsClusterArn" type:"string"` - // The service role associated with the compute environment that allows Batch - // to make calls to Amazon Web Services API operations on your behalf. For more - // information, see Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // The configuration for the Amazon EKS cluster that supports the Batch compute + // environment. Only specify this parameter if the containerOrchestrationType + // is EKS. + EksConfiguration *EksConfiguration `locationName:"eksConfiguration" type:"structure"` + + // The service role that's associated with the compute environment that allows + // Batch to make calls to Amazon Web Services API operations on your behalf. + // For more information, see Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) // in the Batch User Guide. ServiceRole *string `locationName:"serviceRole" type:"string"` @@ -2925,7 +2960,7 @@ type ComputeEnvironmentDetail struct { // If the state is ENABLED, then the Batch scheduler can attempt to place jobs // from an associated job queue on the compute resources within the environment. // If the compute environment is managed, then it can scale its instances out - // or in automatically, based on the job queue demand. + // or in automatically based on the job queue demand. // // If the state is DISABLED, then the Batch scheduler doesn't attempt to place // jobs within the environment. Jobs in a STARTING or RUNNING state continue @@ -2937,7 +2972,7 @@ type ComputeEnvironmentDetail struct { // The current status of the compute environment (for example, CREATING or VALID). Status *string `locationName:"status" type:"string" enum:"CEStatus"` - // A short, human-readable string to provide additional details about the current + // A short, human-readable string to provide additional details for the current // status of the compute environment. StatusReason *string `locationName:"statusReason" type:"string"` @@ -2958,6 +2993,9 @@ type ComputeEnvironmentDetail struct { // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. UpdatePolicy *UpdatePolicy `locationName:"updatePolicy" type:"structure"` + + // Unique identifier for the compute environment. + Uuid *string `locationName:"uuid" type:"string"` } // String returns the string representation. @@ -2996,12 +3034,24 @@ func (s *ComputeEnvironmentDetail) SetComputeResources(v *ComputeResource) *Comp return s } +// SetContainerOrchestrationType sets the ContainerOrchestrationType field's value. +func (s *ComputeEnvironmentDetail) SetContainerOrchestrationType(v string) *ComputeEnvironmentDetail { + s.ContainerOrchestrationType = &v + return s +} + // SetEcsClusterArn sets the EcsClusterArn field's value. func (s *ComputeEnvironmentDetail) SetEcsClusterArn(v string) *ComputeEnvironmentDetail { s.EcsClusterArn = &v return s } +// SetEksConfiguration sets the EksConfiguration field's value. +func (s *ComputeEnvironmentDetail) SetEksConfiguration(v *EksConfiguration) *ComputeEnvironmentDetail { + s.EksConfiguration = v + return s +} + // SetServiceRole sets the ServiceRole field's value. func (s *ComputeEnvironmentDetail) SetServiceRole(v string) *ComputeEnvironmentDetail { s.ServiceRole = &v @@ -3050,7 +3100,13 @@ func (s *ComputeEnvironmentDetail) SetUpdatePolicy(v *UpdatePolicy) *ComputeEnvi return s } -// The order in which compute environments are tried for job placement within +// SetUuid sets the Uuid field's value. +func (s *ComputeEnvironmentDetail) SetUuid(v string) *ComputeEnvironmentDetail { + s.Uuid = &v + return s +} + +// The order that compute environments are tried in for job placement within // a queue. Compute environments are tried in ascending order. For example, // if two compute environments are associated with a job queue, the compute // environment with a lower order integer value is tried for job placement first. @@ -3125,8 +3181,8 @@ func (s *ComputeEnvironmentOrder) SetOrder(v int64) *ComputeEnvironmentOrder { return s } -// An object representing an Batch compute resource. For more information, see -// Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) +// An object that represents an Batch compute resource. For more information, +// see Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. type ComputeResource struct { _ struct{} `type:"structure"` @@ -3138,42 +3194,42 @@ type ComputeResource struct { // For more information, see Allocation strategies (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // BEST_FIT (default) // // Batch selects an instance type that best fits the needs of the jobs with // a preference for the lowest-cost instance type. If additional instances of // the selected instance type aren't available, Batch waits for the additional - // instances to be available. If there aren't enough instances available, or - // if the user is reaching Amazon EC2 service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) - // then additional jobs aren't run until the currently running jobs have completed. - // This allocation strategy keeps costs lower but can limit scaling. If you - // are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be - // specified. Compute resources that use a BEST_FIT allocation strategy don't - // support infrastructure updates and can't update some parameters. For more - // information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // instances to be available. If there aren't enough instances available or + // the user is reaching Amazon EC2 service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html), + // additional jobs aren't run until the currently running jobs are completed. + // This allocation strategy keeps costs lower but can limit scaling. If you're + // using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. + // Compute resources that use a BEST_FIT allocation strategy don't support infrastructure + // updates and can't update some parameters. For more information, see Updating + // compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // // BEST_FIT_PROGRESSIVE // - // Batch will select additional instance types that are large enough to meet - // the requirements of the jobs in the queue, with a preference for instance - // types with a lower cost per unit vCPU. If additional instances of the previously - // selected instance types aren't available, Batch will select new instance - // types. + // Batch selects additional instance types that are large enough to meet the + // requirements of the jobs in the queue. Its preference is for instance types + // with lower cost vCPUs. If additional instances of the previously selected + // instance types aren't available, Batch selects new instance types. // // SPOT_CAPACITY_OPTIMIZED // - // Batch will select one or more instance types that are large enough to meet - // the requirements of the jobs in the queue, with a preference for instance - // types that are less likely to be interrupted. This allocation strategy is - // only available for Spot Instance compute resources. + // Batch selects one or more instance types that are large enough to meet the + // requirements of the jobs in the queue. Its preference is for instance types + // that are less likely to be interrupted. This allocation strategy is only + // available for Spot Instance compute resources. // - // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch - // might need to go above maxvCpus to meet your capacity requirements. In this - // event, Batch never exceeds maxvCpus by more than a single instance. + // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using + // On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, + // Batch might need to exceed maxvCpus to meet your capacity requirements. In + // this event, Batch never exceeds maxvCpus by more than a single instance. AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"CRAllocationStrategy"` // The maximum percentage that a Spot Instance price can be when compared with @@ -3184,41 +3240,41 @@ type ComputeResource struct { // percentage. If you leave this field empty, the default value is 100% of the // On-Demand price. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. BidPercentage *int64 `locationName:"bidPercentage" type:"integer"` // The desired number of Amazon EC2 vCPUS in the compute environment. Batch - // modifies this value between the minimum and maximum values, based on job - // queue demand. + // modifies this value between the minimum and maximum values based on job queue + // demand. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"` - // Provides information used to select Amazon Machine Images (AMIs) for EC2 - // instances in the compute environment. If Ec2Configuration isn't specified, + // Provides information that's used to select Amazon Machine Images (AMIs) for + // EC2 instances in the compute environment. If Ec2Configuration isn't specified, // the default is ECS_AL2. // // One or two values can be provided. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. Ec2Configuration []*Ec2Configuration `locationName:"ec2Configuration" type:"list"` // The Amazon EC2 key pair that's used for instances launched in the compute // environment. You can use this key pair to log in to your instances with SSH. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. Ec2KeyPair *string `locationName:"ec2KeyPair" type:"string"` // The Amazon Machine Image (AMI) ID used for instances launched in the compute // environment. This parameter is overridden by the imageIdOverride member of // the Ec2Configuration structure. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // The AMI that you choose for a compute environment must match the architecture // of the instance types that you intend to use for that compute environment. @@ -3237,8 +3293,8 @@ type ComputeResource struct { // . For more information, see Amazon ECS instance role (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. InstanceRole *string `locationName:"instanceRole" type:"string"` // The instances types that can be launched. You can specify instance families @@ -3247,8 +3303,8 @@ type ComputeResource struct { // can also choose optimal to select instance types (from the C4, M4, and R4 // instance families) that match the demand of your job queues. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // When you create a compute environment, the instance types that you select // for the compute environment must share the same architecture. For example, @@ -3256,7 +3312,7 @@ type ComputeResource struct { // // Currently, optimal uses instance types from the C4, M4, and R4 instance families. // In Regions that don't have instance types from those instance families, instance - // types from the C5, M5. and R5 instance families are used. + // types from the C5, M5, and R5 instance families are used. InstanceTypes []*string `locationName:"instanceTypes" type:"list"` // The launch template to use for your compute resources. Any other compute @@ -3266,13 +3322,14 @@ type ComputeResource struct { // For more information, see Launch template support (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. LaunchTemplate *LaunchTemplateSpecification `locationName:"launchTemplate" type:"structure"` // The maximum number of Amazon EC2 vCPUs that a compute environment can reach. // - // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, + // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies + // using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, // Batch might need to exceed maxvCpus to meet your capacity requirements. In // this event, Batch never exceeds maxvCpus by more than a single instance. // For example, no more than a single instance from among those specified in @@ -3284,8 +3341,8 @@ type ComputeResource struct { // The minimum number of Amazon EC2 vCPUs that an environment should maintain // (even if the compute environment is DISABLED). // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. MinvCpus *int64 `locationName:"minvCpus" type:"integer"` // The Amazon EC2 placement group to associate with your compute resources. @@ -3296,13 +3353,13 @@ type ComputeResource struct { // flow potential. For more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) // in the Amazon EC2 User Guide for Linux Instances. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. PlacementGroup *string `locationName:"placementGroup" type:"string"` - // The Amazon EC2 security groups associated with instances launched in the - // compute environment. One or more security groups must be specified, either - // in securityGroupIds or using a launch template referenced in launchTemplate. + // The Amazon EC2 security groups that are associated with instances launched + // in the compute environment. One or more security groups must be specified, + // either in securityGroupIds or using a launch template referenced in launchTemplate. // This parameter is required for jobs that are running on Fargate resources // and must contain at least one security group. Fargate doesn't support launch // templates. If security groups are specified using both securityGroupIds and @@ -3315,8 +3372,8 @@ type ComputeResource struct { // see Amazon EC2 spot fleet role (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // To tag your Spot Instances on creation, the Spot Fleet IAM role specified // here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The @@ -3336,16 +3393,16 @@ type ComputeResource struct { // Key-value pair tags to be applied to EC2 resources that are launched in the // compute environment. For Batch, these take the form of "String1": "String2", - // where String1 is the tag key and String2 is the tag value−for example, - // { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing + // where String1 is the tag key and String2 is the tag value-for example, { + // "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing // your Batch instances in the Amazon EC2 console. Updating these tags requires // an infrastructure update to the compute environment. For more information, // see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource // API operation. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. Tags map[string]*string `locationName:"tags" type:"map"` // The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For @@ -3510,16 +3567,16 @@ func (s *ComputeResource) SetType(v string) *ComputeResource { return s } -// An object representing the attributes of a compute environment that can be -// updated. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) +// An object that represents the attributes of a compute environment that can +// be updated. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. type ComputeResourceUpdate struct { _ struct{} `type:"structure"` - // The allocation strategy to use for the compute resource if not enough instances - // of the best fitting instance type can be allocated. This might be because - // of availability of the instance type in the Region or Amazon EC2 service - // limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html). + // The allocation strategy to use for the compute resource if there's not enough + // instances of the best fitting instance type that can be allocated. This might + // be because of availability of the instance type in the Region or Amazon EC2 + // service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html). // For more information, see Allocation strategies (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) // in the Batch User Guide. // @@ -3529,51 +3586,50 @@ type ComputeResourceUpdate struct { // in the Batch User Guide. BEST_FIT isn't supported when updating a compute // environment. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // BEST_FIT_PROGRESSIVE // - // Batch will select additional instance types that are large enough to meet - // the requirements of the jobs in the queue, with a preference for instance - // types with a lower cost per unit vCPU. If additional instances of the previously - // selected instance types aren't available, Batch will select new instance - // types. + // Batch selects additional instance types that are large enough to meet the + // requirements of the jobs in the queue. Its preference is for instance types + // with lower cost vCPUs. If additional instances of the previously selected + // instance types aren't available, Batch selects new instance types. // // SPOT_CAPACITY_OPTIMIZED // - // Batch will select one or more instance types that are large enough to meet - // the requirements of the jobs in the queue, with a preference for instance - // types that are less likely to be interrupted. This allocation strategy is - // only available for Spot Instance compute resources. + // Batch selects one or more instance types that are large enough to meet the + // requirements of the jobs in the queue. Its preference is for instance types + // that are less likely to be interrupted. This allocation strategy is only + // available for Spot Instance compute resources. // - // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch - // might need to go above maxvCpus to meet your capacity requirements. In this - // event, Batch never exceeds maxvCpus by more than a single instance. + // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using + // On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, + // Batch might need to exceed maxvCpus to meet your capacity requirements. In + // this event, Batch never exceeds maxvCpus by more than a single instance. AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"CRUpdateAllocationStrategy"` // The maximum percentage that a Spot Instance price can be when compared with // the On-Demand price for that instance type before instances are launched. - // For example, if your maximum percentage is 20%, then the Spot price must - // be less than 20% of the current On-Demand price for that Amazon EC2 instance. - // You always pay the lowest (market) price and never more than your maximum - // percentage. + // For example, if your maximum percentage is 20%, the Spot price must be less + // than 20% of the current On-Demand price for that Amazon EC2 instance. You + // always pay the lowest (market) price and never more than your maximum percentage. // // When updating a compute environment, changing the bid percentage requires // an infrastructure update of the compute environment. For more information, // see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. BidPercentage *int64 `locationName:"bidPercentage" type:"integer"` // The desired number of Amazon EC2 vCPUS in the compute environment. Batch // modifies this value between the minimum and maximum values based on job queue // demand. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"` // Provides information used to select Amazon Machine Images (AMIs) for EC2 @@ -3588,8 +3644,8 @@ type ComputeResourceUpdate struct { // // One or two values can be provided. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. Ec2Configuration []*Ec2Configuration `locationName:"ec2Configuration" type:"list"` // The Amazon EC2 key pair that's used for instances launched in the compute @@ -3601,8 +3657,8 @@ type ComputeResourceUpdate struct { // Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. Ec2KeyPair *string `locationName:"ec2KeyPair" type:"string"` // The Amazon Machine Image (AMI) ID used for instances launched in the compute @@ -3615,8 +3671,8 @@ type ComputeResourceUpdate struct { // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // The AMI that you choose for a compute environment must match the architecture // of the instance types that you intend to use for that compute environment. @@ -3638,8 +3694,8 @@ type ComputeResourceUpdate struct { // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. InstanceRole *string `locationName:"instanceRole" type:"string"` // The instances types that can be launched. You can specify instance families @@ -3653,8 +3709,8 @@ type ComputeResourceUpdate struct { // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. // // When you create a compute environment, the instance types that you select // for the compute environment must share the same architecture. For example, @@ -3662,7 +3718,7 @@ type ComputeResourceUpdate struct { // // Currently, optimal uses instance types from the C4, M4, and R4 instance families. // In Regions that don't have instance types from those instance families, instance - // types from the C5, M5. and R5 instance families are used. + // types from the C5, M5, and R5 instance families are used. InstanceTypes []*string `locationName:"instanceTypes" type:"list"` // The updated launch template to use for your compute resources. You must specify @@ -3680,13 +3736,14 @@ type ComputeResourceUpdate struct { // see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. LaunchTemplate *LaunchTemplateSpecification `locationName:"launchTemplate" type:"structure"` // The maximum number of Amazon EC2 vCPUs that an environment can reach. // - // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, + // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies + // using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, // Batch might need to exceed maxvCpus to meet your capacity requirements. In // this event, Batch never exceeds maxvCpus by more than a single instance. // That is, no more than a single instance from among those specified in your @@ -3696,8 +3753,8 @@ type ComputeResourceUpdate struct { // The minimum number of Amazon EC2 vCPUs that an environment should maintain // (even if the compute environment is DISABLED). // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. MinvCpus *int64 `locationName:"minvCpus" type:"integer"` // The Amazon EC2 placement group to associate with your compute resources. @@ -3713,16 +3770,16 @@ type ComputeResourceUpdate struct { // see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. PlacementGroup *string `locationName:"placementGroup" type:"string"` - // The Amazon EC2 security groups associated with instances launched in the - // compute environment. This parameter is required for Fargate compute resources, - // where it can contain up to 5 security groups. For Fargate compute resources, - // providing an empty list is handled as if this parameter wasn't specified - // and no change is made. For EC2 compute resources, providing an empty list - // removes the security groups from the compute resource. + // The Amazon EC2 security groups that are associated with instances launched + // in the compute environment. This parameter is required for Fargate compute + // resources, where it can contain up to 5 security groups. For Fargate compute + // resources, providing an empty list is handled as if this parameter wasn't + // specified and no change is made. For EC2 compute resources, providing an + // empty list removes the security groups from the compute resource. // // When updating a compute environment, changing the EC2 security groups requires // an infrastructure update of the compute environment. For more information, @@ -3746,8 +3803,8 @@ type ComputeResourceUpdate struct { // Key-value pair tags to be applied to EC2 resources that are launched in the // compute environment. For Batch, these take the form of "String1": "String2", - // where String1 is the tag key and String2 is the tag value−for example, - // { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing + // where String1 is the tag key and String2 is the tag value-for example, { + // "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing // your Batch instances in the Amazon EC2 console. These tags aren't seen when // using the Batch ListTagsForResource API operation. // @@ -3756,8 +3813,8 @@ type ComputeResourceUpdate struct { // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. // - // This parameter isn't applicable to jobs that are running on Fargate resources, - // and shouldn't be specified. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. Tags map[string]*string `locationName:"tags" type:"map"` // The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For @@ -3779,9 +3836,10 @@ type ComputeResourceUpdate struct { // by Batch when the compute environment has an infrastructure update. The default // value is false. // - // If an AMI ID is specified in the imageId or imageIdOverride parameters or - // by the launch template specified in the launchTemplate parameter, this parameter - // is ignored. For more information on updating AMI IDs during an infrastructure + // An AMI ID can either be specified in the imageId or imageIdOverride parameters + // or be determined by the launch template that's specified in the launchTemplate + // parameter. If an AMI ID is specified any of these ways, this parameter is + // ignored. For more information about to update AMI IDs during an infrastructure // update, see Updating the AMI ID (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) // in the Batch User Guide. // @@ -3932,7 +3990,7 @@ func (s *ComputeResourceUpdate) SetUpdateToLatestImageVersion(v bool) *ComputeRe return s } -// An object representing the details of a container that's part of a job. +// An object that represents the details of a container that's part of a job. type ContainerDetail struct { _ struct{} `type:"structure"` @@ -3945,8 +4003,8 @@ type ContainerDetail struct { // The environment variables to pass to a container. // - // Environment variables must not start with AWS_BATCH; this naming convention - // is reserved for variables that are set by the Batch service. + // Environment variables cannot start with "AWS_BATCH". This naming convention + // is reserved for variables that Batch sets. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The Amazon Resource Name (ARN) of the execution role that Batch can assume. @@ -3970,7 +4028,7 @@ type ContainerDetail struct { // This parameter isn't applicable to jobs that are running on Fargate resources. InstanceType *string `locationName:"instanceType" type:"string"` - // The Amazon Resource Name (ARN) associated with the job upon execution. + // The Amazon Resource Name (ARN) that's associated with the job when run. JobRoleArn *string `locationName:"jobRoleArn" type:"string"` // Linux-specific modifications that are applied to the container, such as details @@ -3998,7 +4056,7 @@ type ContainerDetail struct { // // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your - // container instance, log into your container instance and run the following + // container instance, log in to your container instance and run the following // command: sudo docker version | grep "Server API version" // // The Amazon ECS container agent running on a container instance must register @@ -4009,9 +4067,9 @@ type ContainerDetail struct { // in the Amazon Elastic Container Service Developer Guide. LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"` - // The name of the CloudWatch Logs log stream associated with the container. - // The log group for Batch jobs is /aws/batch/job. Each container attempt receives - // a log stream name when they reach the RUNNING status. + // The name of the Amazon CloudWatch Logs log stream that's associated with + // the container. The log group for Batch jobs is /aws/batch/job. Each container + // attempt receives a log stream name when they reach the RUNNING status. LogStreamName *string `locationName:"logStreamName" type:"string"` // For jobs running on EC2 resources that didn't specify memory requirements @@ -4026,7 +4084,7 @@ type ContainerDetail struct { // Jobs that are running on EC2 resources must not specify this parameter. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` - // The network interfaces associated with the job. + // The network interfaces that are associated with the job. NetworkInterfaces []*NetworkInterface `locationName:"networkInterfaces" type:"list"` // When this parameter is true, the container is given elevated permissions @@ -4045,7 +4103,7 @@ type ContainerDetail struct { ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"` // A short (255 max characters) human-readable string to provide additional - // details about a running or stopped container. + // details for a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The type and amount of resources to assign to a container. The supported @@ -4091,7 +4149,7 @@ type ContainerDetail struct { // for the job using resourceRequirements. Vcpus *int64 `locationName:"vcpus" type:"integer"` - // A list of volumes associated with the job. + // A list of volumes that are associated with the job. Volumes []*Volume `locationName:"volumes" type:"list"` } @@ -4281,8 +4339,8 @@ type ContainerOverrides struct { // variables, which are added to the container at launch, or you can override // the existing environment variables from the Docker image or the job definition. // - // Environment variables must not start with AWS_BATCH; this naming convention - // is reserved for variables that are set by the Batch service. + // Environment variables cannot start with "AWS_BATCH". This naming convention + // is reserved for variables that Batch sets. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The instance type to use for a multi-node parallel job. @@ -4293,11 +4351,11 @@ type ContainerOverrides struct { // This parameter is deprecated, use resourceRequirements to override the memory // requirements specified in the job definition. It's not supported for jobs - // running on Fargate resources. For jobs running on EC2 resources, it overrides + // running on Fargate resources. For jobs that run on EC2 resources, it overrides // the memory parameter set in the job definition, but doesn't override any - // memory requirement specified in the resourceRequirements structure in the - // job definition. To override memory requirements that are specified in the - // resourceRequirements structure in the job definition, resourceRequirements + // memory requirement that's specified in the resourceRequirements structure + // in the job definition. To override memory requirements that are specified + // in the resourceRequirements structure in the job definition, resourceRequirements // must be specified in the SubmitJob request, with type set to MEMORY and value // set to the new value. For more information, see Can't override job definition // resource requirements (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements) @@ -4313,7 +4371,7 @@ type ContainerOverrides struct { // This parameter is deprecated, use resourceRequirements to override the vcpus // parameter that's set in the job definition. It's not supported for jobs running - // on Fargate resources. For jobs running on EC2 resources, it overrides the + // on Fargate resources. For jobs that run on EC2 resources, it overrides the // vcpus parameter set in the job definition, but doesn't override any vCPU // requirement specified in the resourceRequirements structure in the job definition. // To override vCPU requirements that are specified in the resourceRequirements @@ -4401,8 +4459,8 @@ func (s *ContainerOverrides) SetVcpus(v int64) *ContainerOverrides { return s } -// Container properties are used in job definitions to describe the container -// that's launched as part of a job. +// Container properties are used for Amazon ECS based job definitions. These +// properties to describe the container that's launched as part of a job. type ContainerProperties struct { _ struct{} `type:"structure"` @@ -4422,8 +4480,8 @@ type ContainerProperties struct { // We don't recommend using plaintext environment variables for sensitive information, // such as credential data. // - // Environment variables must not start with AWS_BATCH; this naming convention - // is reserved for variables that are set by the Batch service. + // Environment variables cannot start with "AWS_BATCH". This naming convention + // is reserved for variables that Batch sets. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The Amazon Resource Name (ARN) of the execution role that Batch can assume. @@ -4438,12 +4496,13 @@ type ContainerProperties struct { // The image used to start a container. This string is passed directly to the // Docker daemon. Images in the Docker Hub registry are available by default. - // Other repositories are specified with repository-url/image:tag . Up to 255 - // letters (uppercase and lowercase), numbers, hyphens, underscores, colons, - // periods, forward slashes, and number signs are allowed. This parameter maps - // to Image in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) - // and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). + // Other repositories are specified with repository-url/image:tag . It can be + // 255 characters long. It can contain uppercase and lowercase letters, numbers, + // hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), + // and number signs (#). This parameter maps to Image in the Create a container + // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of + // the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the + // IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). // // Docker image architecture must match the processor architecture of the compute // resources that they're scheduled on. For example, ARM-based Docker images @@ -4453,7 +4512,7 @@ type ContainerProperties struct { // or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest . // // * Images in Amazon ECR repositories use the full registry and repository - // URI (for example, 012345678910.dkr.ecr..amazonaws.com/). + // URI (for example, 123456789012.dkr.ecr..amazonaws.com/). // // * Images in official repositories on Docker Hub use a single name (for // example, ubuntu or mongo). @@ -4501,7 +4560,7 @@ type ContainerProperties struct { // // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your - // container instance, log into your container instance and run the following + // container instance, log in to your container instance and run the following // command: sudo docker version | grep "Server API version" // // The Amazon ECS container agent running on a container instance must register @@ -4514,7 +4573,7 @@ type ContainerProperties struct { // This parameter is deprecated, use resourceRequirements to specify the memory // requirements for the job definition. It's not supported for jobs running - // on Fargate resources. For jobs running on EC2 resources, it specifies the + // on Fargate resources. For jobs that run on EC2 resources, it specifies the // memory hard limit (in MiB) for a container. If your container attempts to // exceed the specified number, it's terminated. You must specify at least 4 // MiB of memory for a job using this parameter. The memory hard limit can be @@ -4793,7 +4852,7 @@ func (s *ContainerProperties) SetVolumes(v []*Volume) *ContainerProperties { return s } -// An object representing summary details of a container within a job. +// An object that represents summary details of a container within a job. type ContainerSummary struct { _ struct{} `type:"structure"` @@ -4801,7 +4860,7 @@ type ContainerSummary struct { ExitCode *int64 `locationName:"exitCode" type:"integer"` // A short (255 max characters) human-readable string to provide additional - // details about a running or stopped container. + // details for a running or stopped container. Reason *string `locationName:"reason" type:"string"` } @@ -4839,7 +4898,7 @@ func (s *ContainerSummary) SetReason(v string) *ContainerSummary { type CreateComputeEnvironmentInput struct { _ struct{} `type:"structure"` - // The name for your compute environment. It can be up to 128 letters long. + // The name for your compute environment. It can be up to 128 characters long. // It can contain uppercase and lowercase letters, numbers, hyphens (-), and // underscores (_). // @@ -4852,6 +4911,9 @@ type CreateComputeEnvironmentInput struct { // in the Batch User Guide. ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"` + // The details for the Amazon EKS cluster that supports the compute environment. + EksConfiguration *EksConfiguration `locationName:"eksConfiguration" type:"structure"` + // The full Amazon Resource Name (ARN) of the IAM role that allows Batch to // make calls to other Amazon Web Services services on your behalf. For more // information, see Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) @@ -4865,9 +4927,8 @@ type CreateComputeEnvironmentInput struct { // // If your specified role has a path other than /, then you must specify either // the full role ARN (recommended) or prefix the role name with the path. For - // example, if a role with the name bar has a path of /foo/ then you would specify - // /foo/bar as the role name. For more information, see Friendly names and paths - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) + // example, if a role with the name bar has a path of /foo/, specify /foo/bar + // as the role name. For more information, see Friendly names and paths (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) // in the IAM User Guide. // // Depending on how you created your Batch service role, its ARN might contain @@ -4954,6 +5015,11 @@ func (s *CreateComputeEnvironmentInput) Validate() error { invalidParams.AddNested("ComputeResources", err.(request.ErrInvalidParams)) } } + if s.EksConfiguration != nil { + if err := s.EksConfiguration.Validate(); err != nil { + invalidParams.AddNested("EksConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -4973,6 +5039,12 @@ func (s *CreateComputeEnvironmentInput) SetComputeResources(v *ComputeResource) return s } +// SetEksConfiguration sets the EksConfiguration field's value. +func (s *CreateComputeEnvironmentInput) SetEksConfiguration(v *EksConfiguration) *CreateComputeEnvironmentInput { + s.EksConfiguration = v + return s +} + // SetServiceRole sets the ServiceRole field's value. func (s *CreateComputeEnvironmentInput) SetServiceRole(v string) *CreateComputeEnvironmentInput { s.ServiceRole = &v @@ -5009,9 +5081,9 @@ type CreateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string"` - // The name of the compute environment. It can be up to 128 letters long. It - // can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores - // (_). + // The name of the compute environment. It can be up to 128 characters long. + // It can contain uppercase and lowercase letters, numbers, hyphens (-), and + // underscores (_). ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string"` } @@ -5086,7 +5158,7 @@ type CreateJobQueueInput struct { // If this parameter isn't specified, the job queue uses a first in, first out // (FIFO) scheduling policy. After a job queue is created, you can replace but // can't remove the fair share scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name - // . An example is aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy. + // . An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. SchedulingPolicyArn *string `locationName:"schedulingPolicyArn" type:"string"` // The state of the job queue. If the job queue state is ENABLED, it is able @@ -5317,7 +5389,7 @@ type CreateSchedulingPolicyOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name - // . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy. + // . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` @@ -5657,8 +5729,8 @@ type DescribeComputeEnvironmentsInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that's only used to - // retrieve the next items in a list and not for other programmatic purposes. + // Treat this token as an opaque identifier that's only used to retrieve the + // next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -5768,8 +5840,8 @@ type DescribeJobDefinitionsInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that's only used to - // retrieve the next items in a list and not for other programmatic purposes. + // Treat this token as an opaque identifier that's only used to retrieve the + // next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // The status used to filter job definitions. @@ -5890,8 +5962,8 @@ type DescribeJobQueuesInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that's only used to - // retrieve the next items in a list and not for other programmatic purposes. + // Treat this token as an opaque identifier that's only used to retrieve the + // next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -6130,7 +6202,7 @@ func (s *DescribeSchedulingPoliciesOutput) SetSchedulingPolicies(v []*Scheduling return s } -// An object representing a container instance host device. +// An object that represents a container instance host device. // // This object isn't applicable to jobs that are running on Fargate resources // and shouldn't be provided. @@ -6194,33 +6266,1698 @@ func (s *Device) SetHostPath(v string) *Device { return s } -// SetPermissions sets the Permissions field's value. -func (s *Device) SetPermissions(v []*string) *Device { - s.Permissions = v +// SetPermissions sets the Permissions field's value. +func (s *Device) SetPermissions(v []*string) *Device { + s.Permissions = v + return s +} + +// The authorization configuration details for the Amazon EFS file system. +type EFSAuthorizationConfig struct { + _ struct{} `type:"structure"` + + // The Amazon EFS access point ID to use. If an access point is specified, the + // root directory value specified in the EFSVolumeConfiguration must either + // be omitted or set to / which enforces the path set on the EFS access point. + // If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. + // For more information, see Working with Amazon EFS access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) + // in the Amazon Elastic File System User Guide. + AccessPointId *string `locationName:"accessPointId" type:"string"` + + // Whether or not to use the Batch job IAM role defined in a job definition + // when mounting the Amazon EFS file system. If enabled, transit encryption + // must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, + // the default value of DISABLED is used. For more information, see Using Amazon + // EFS access points (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) + // in the Batch User Guide. EFS IAM authorization requires that TransitEncryption + // be ENABLED and that a JobRoleArn is specified. + Iam *string `locationName:"iam" type:"string" enum:"EFSAuthorizationConfigIAM"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EFSAuthorizationConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EFSAuthorizationConfig) GoString() string { + return s.String() +} + +// SetAccessPointId sets the AccessPointId field's value. +func (s *EFSAuthorizationConfig) SetAccessPointId(v string) *EFSAuthorizationConfig { + s.AccessPointId = &v + return s +} + +// SetIam sets the Iam field's value. +func (s *EFSAuthorizationConfig) SetIam(v string) *EFSAuthorizationConfig { + s.Iam = &v + return s +} + +// This is used when you're using an Amazon Elastic File System file system +// for job storage. For more information, see Amazon EFS Volumes (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) +// in the Batch User Guide. +type EFSVolumeConfiguration struct { + _ struct{} `type:"structure"` + + // The authorization configuration details for the Amazon EFS file system. + AuthorizationConfig *EFSAuthorizationConfig `locationName:"authorizationConfig" type:"structure"` + + // The Amazon EFS file system ID to use. + // + // FileSystemId is a required field + FileSystemId *string `locationName:"fileSystemId" type:"string" required:"true"` + + // The directory within the Amazon EFS file system to mount as the root directory + // inside the host. If this parameter is omitted, the root of the Amazon EFS + // volume is used instead. Specifying / has the same effect as omitting this + // parameter. The maximum length is 4,096 characters. + // + // If an EFS access point is specified in the authorizationConfig, the root + // directory parameter must either be omitted or set to /, which enforces the + // path set on the Amazon EFS access point. + RootDirectory *string `locationName:"rootDirectory" type:"string"` + + // Determines whether to enable encryption for Amazon EFS data in transit between + // the Amazon ECS host and the Amazon EFS server. Transit encryption must be + // enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, + // the default value of DISABLED is used. For more information, see Encrypting + // data in transit (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) + // in the Amazon Elastic File System User Guide. + TransitEncryption *string `locationName:"transitEncryption" type:"string" enum:"EFSTransitEncryption"` + + // The port to use when sending encrypted data between the Amazon ECS host and + // the Amazon EFS server. If you don't specify a transit encryption port, it + // uses the port selection strategy that the Amazon EFS mount helper uses. The + // value must be between 0 and 65,535. For more information, see EFS mount helper + // (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the + // Amazon Elastic File System User Guide. + TransitEncryptionPort *int64 `locationName:"transitEncryptionPort" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EFSVolumeConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EFSVolumeConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EFSVolumeConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EFSVolumeConfiguration"} + if s.FileSystemId == nil { + invalidParams.Add(request.NewErrParamRequired("FileSystemId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAuthorizationConfig sets the AuthorizationConfig field's value. +func (s *EFSVolumeConfiguration) SetAuthorizationConfig(v *EFSAuthorizationConfig) *EFSVolumeConfiguration { + s.AuthorizationConfig = v + return s +} + +// SetFileSystemId sets the FileSystemId field's value. +func (s *EFSVolumeConfiguration) SetFileSystemId(v string) *EFSVolumeConfiguration { + s.FileSystemId = &v + return s +} + +// SetRootDirectory sets the RootDirectory field's value. +func (s *EFSVolumeConfiguration) SetRootDirectory(v string) *EFSVolumeConfiguration { + s.RootDirectory = &v + return s +} + +// SetTransitEncryption sets the TransitEncryption field's value. +func (s *EFSVolumeConfiguration) SetTransitEncryption(v string) *EFSVolumeConfiguration { + s.TransitEncryption = &v + return s +} + +// SetTransitEncryptionPort sets the TransitEncryptionPort field's value. +func (s *EFSVolumeConfiguration) SetTransitEncryptionPort(v int64) *EFSVolumeConfiguration { + s.TransitEncryptionPort = &v + return s +} + +// Provides information used to select Amazon Machine Images (AMIs) for instances +// in the compute environment. If Ec2Configuration isn't specified, the default +// is ECS_AL2 (Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)). +// +// This object isn't applicable to jobs that are running on Fargate resources. +type Ec2Configuration struct { + _ struct{} `type:"structure"` + + // The AMI ID used for instances launched in the compute environment that match + // the image type. This setting overrides the imageId set in the computeResource + // object. + // + // The AMI that you choose for a compute environment must match the architecture + // of the instance types that you intend to use for that compute environment. + // For example, if your compute environment uses A1 instance types, the compute + // resource AMI that you choose must support ARM instances. Amazon ECS vends + // both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. + // For more information, see Amazon ECS-optimized Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) + // in the Amazon Elastic Container Service Developer Guide. + ImageIdOverride *string `locationName:"imageIdOverride" min:"1" type:"string"` + + // The Kubernetes version for the compute environment. If you don't specify + // a value, the latest version that Batch supports is used. + ImageKubernetesVersion *string `locationName:"imageKubernetesVersion" min:"1" type:"string"` + + // The image type to match with the instance type to select an AMI. The supported + // values are different for ECS and EKS resources. + // + // ECS + // + // If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized + // Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) + // (ECS_AL2) is used. If a new image type is specified in an update, but neither + // an imageId nor a imageIdOverride parameter is specified, then the latest + // Amazon ECS optimized AMI for that image type that's supported by Batch is + // used. + // + // ECS_AL2 + // + // Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami): + // Default for all non-GPU instance families. + // + // ECS_AL2_NVIDIA + // + // Amazon Linux 2 (GPU) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami): + // Default for all GPU instance families (for example P4 and G4) and can be + // used for all non Amazon Web Services Graviton-based instance types. + // + // ECS_AL1 + // + // Amazon Linux (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami). + // Amazon Linux has reached the end-of-life of standard support. For more information, + // see Amazon Linux AMI (http://aws.amazon.com/amazon-linux-ami/). + // + // EKS + // + // If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized + // Amazon Linux AMI (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) + // (EKS_AL2) is used. If a new image type is specified in an update, but neither + // an imageId nor a imageIdOverride parameter is specified, then the latest + // Amazon EKS optimized AMI for that image type that Batch supports is used. + // + // EKS_AL2 + // + // Amazon Linux 2 (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): + // Default for all non-GPU instance families. + // + // EKS_AL2_NVIDIA + // + // Amazon Linux 2 (accelerated) (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): + // Default for all GPU instance families (for example, P4 and G4) and can be + // used for all non Amazon Web Services Graviton-based instance types. + // + // ImageType is a required field + ImageType *string `locationName:"imageType" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Ec2Configuration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Ec2Configuration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Ec2Configuration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Ec2Configuration"} + if s.ImageIdOverride != nil && len(*s.ImageIdOverride) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ImageIdOverride", 1)) + } + if s.ImageKubernetesVersion != nil && len(*s.ImageKubernetesVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ImageKubernetesVersion", 1)) + } + if s.ImageType == nil { + invalidParams.Add(request.NewErrParamRequired("ImageType")) + } + if s.ImageType != nil && len(*s.ImageType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ImageType", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetImageIdOverride sets the ImageIdOverride field's value. +func (s *Ec2Configuration) SetImageIdOverride(v string) *Ec2Configuration { + s.ImageIdOverride = &v + return s +} + +// SetImageKubernetesVersion sets the ImageKubernetesVersion field's value. +func (s *Ec2Configuration) SetImageKubernetesVersion(v string) *Ec2Configuration { + s.ImageKubernetesVersion = &v + return s +} + +// SetImageType sets the ImageType field's value. +func (s *Ec2Configuration) SetImageType(v string) *Ec2Configuration { + s.ImageType = &v + return s +} + +// An object that represents the details for an attempt for a job attempt that +// an Amazon EKS container runs. +type EksAttemptContainerDetail struct { + _ struct{} `type:"structure"` + + // The exit code for the job attempt. A non-zero exit code is considered failed. + ExitCode *int64 `locationName:"exitCode" type:"integer"` + + // A short (255 max characters) human-readable string to provide additional + // details for a running or stopped container. + Reason *string `locationName:"reason" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksAttemptContainerDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksAttemptContainerDetail) GoString() string { + return s.String() +} + +// SetExitCode sets the ExitCode field's value. +func (s *EksAttemptContainerDetail) SetExitCode(v int64) *EksAttemptContainerDetail { + s.ExitCode = &v + return s +} + +// SetReason sets the Reason field's value. +func (s *EksAttemptContainerDetail) SetReason(v string) *EksAttemptContainerDetail { + s.Reason = &v + return s +} + +// An object that represents the details of a job attempt for a job attempt +// by an Amazon EKS container. +type EksAttemptDetail struct { + _ struct{} `type:"structure"` + + // The details for the final status of the containers for this job attempt. + Containers []*EksAttemptContainerDetail `locationName:"containers" type:"list"` + + // The name of the node for this job attempt. + NodeName *string `locationName:"nodeName" type:"string"` + + // The name of the pod for this job attempt. + PodName *string `locationName:"podName" type:"string"` + + // The Unix timestamp (in milliseconds) for when the attempt was started (when + // the attempt transitioned from the STARTING state to the RUNNING state). + StartedAt *int64 `locationName:"startedAt" type:"long"` + + // A short, human-readable string to provide additional details for the current + // status of the job attempt. + StatusReason *string `locationName:"statusReason" type:"string"` + + // The Unix timestamp (in milliseconds) for when the attempt was stopped. This + // happens when the attempt transitioned from the RUNNING state to a terminal + // state, such as SUCCEEDED or FAILED. + StoppedAt *int64 `locationName:"stoppedAt" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksAttemptDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksAttemptDetail) GoString() string { + return s.String() +} + +// SetContainers sets the Containers field's value. +func (s *EksAttemptDetail) SetContainers(v []*EksAttemptContainerDetail) *EksAttemptDetail { + s.Containers = v + return s +} + +// SetNodeName sets the NodeName field's value. +func (s *EksAttemptDetail) SetNodeName(v string) *EksAttemptDetail { + s.NodeName = &v + return s +} + +// SetPodName sets the PodName field's value. +func (s *EksAttemptDetail) SetPodName(v string) *EksAttemptDetail { + s.PodName = &v + return s +} + +// SetStartedAt sets the StartedAt field's value. +func (s *EksAttemptDetail) SetStartedAt(v int64) *EksAttemptDetail { + s.StartedAt = &v + return s +} + +// SetStatusReason sets the StatusReason field's value. +func (s *EksAttemptDetail) SetStatusReason(v string) *EksAttemptDetail { + s.StatusReason = &v + return s +} + +// SetStoppedAt sets the StoppedAt field's value. +func (s *EksAttemptDetail) SetStoppedAt(v int64) *EksAttemptDetail { + s.StoppedAt = &v + return s +} + +// Configuration for the Amazon EKS cluster that supports the Batch compute +// environment. The cluster must exist before the compute environment can be +// created. +type EksConfiguration struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch . + // + // EksClusterArn is a required field + EksClusterArn *string `locationName:"eksClusterArn" type:"string" required:"true"` + + // The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. + // The value can't left empty or null. It must be fewer than 64 characters long, + // can't be set to default, can't start with "kube-," and must match this regular + // expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces + // (https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) + // in the Kubernetes documentation. + // + // KubernetesNamespace is a required field + KubernetesNamespace *string `locationName:"kubernetesNamespace" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksConfiguration"} + if s.EksClusterArn == nil { + invalidParams.Add(request.NewErrParamRequired("EksClusterArn")) + } + if s.KubernetesNamespace == nil { + invalidParams.Add(request.NewErrParamRequired("KubernetesNamespace")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEksClusterArn sets the EksClusterArn field's value. +func (s *EksConfiguration) SetEksClusterArn(v string) *EksConfiguration { + s.EksClusterArn = &v + return s +} + +// SetKubernetesNamespace sets the KubernetesNamespace field's value. +func (s *EksConfiguration) SetKubernetesNamespace(v string) *EksConfiguration { + s.KubernetesNamespace = &v + return s +} + +// EKS container properties are used in job definitions for Amazon EKS based +// job definitions to describe the properties for a container node in the pod +// that's launched as part of a job. This can't be specified for Amazon ECS +// based job definitions. +type EksContainer struct { + _ struct{} `type:"structure"` + + // An array of arguments to the entrypoint. If this isn't specified, the CMD + // of the container image is used. This corresponds to the args member in the + // Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // portion of the Pod (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) + // 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 changed. For example, if the reference is to "$(NAME1)" and + // the NAME1 environment variable doesn't exist, the command string will remain + // "$(NAME1)." $$ is replaced with $, and the resulting string isn't expanded. + // For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME + // environment variable exists. For more information, see CMD (https://docs.docker.com/engine/reference/builder/#cmd) + // in the Dockerfile reference and Define a command and arguments for a pod + // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // in the Kubernetes documentation. + Args []*string `locationName:"args" type:"list"` + + // The entrypoint for the container. This isn't run within a shell. If this + // isn't specified, the ENTRYPOINT of the container image is used. 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 changed. For example, if the reference is to "$(NAME1)" and + // the NAME1 environment variable doesn't exist, the command string will remain + // "$(NAME1)." $$ is replaced with $ and the resulting string isn't expanded. + // For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the + // VAR_NAME environment variable exists. The entrypoint can't be updated. For + // more information, see ENTRYPOINT (https://docs.docker.com/engine/reference/builder/#entrypoint) + // in the Dockerfile reference and Define a command and arguments for a container + // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // and Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // in the Kubernetes documentation. + Command []*string `locationName:"command" type:"list"` + + // The environment variables to pass to a container. + // + // Environment variables cannot start with "AWS_BATCH". This naming convention + // is reserved for variables that Batch sets. + Env []*EksContainerEnvironmentVariable `locationName:"env" type:"list"` + + // The Docker image used to start the container. + // + // Image is a required field + Image *string `locationName:"image" type:"string" required:"true"` + + // The image pull policy for the container. Supported values are Always, IfNotPresent, + // and Never. This parameter defaults to IfNotPresent. However, if the :latest + // tag is specified, it defaults to Always. For more information, see Updating + // images (https://kubernetes.io/docs/concepts/containers/images/#updating-images) + // in the Kubernetes documentation. + ImagePullPolicy *string `locationName:"imagePullPolicy" type:"string"` + + // The name of the container. If the name isn't specified, the default name + // "Default" is used. Each container in a pod must have a unique name. + Name *string `locationName:"name" type:"string"` + + // The type and amount of resources to assign to a container. The supported + // resources include memory, cpu, and nvidia.com/gpu. For more information, + // see Resource management for pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) + // in the Kubernetes documentation. + Resources *EksContainerResourceRequirements `locationName:"resources" type:"structure"` + + // The security context for a job. For more information, see Configure a security + // context for a pod or container (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) + // in the Kubernetes documentation. + SecurityContext *EksContainerSecurityContext `locationName:"securityContext" type:"structure"` + + // The volume mounts for the container. Batch supports emptyDir, hostPath, and + // secret volume types. For more information about volumes and volume mounts + // in Kubernetes, see Volumes (https://kubernetes.io/docs/concepts/storage/volumes/) + // in the Kubernetes documentation. + VolumeMounts []*EksContainerVolumeMount `locationName:"volumeMounts" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainer) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainer) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksContainer) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksContainer"} + if s.Image == nil { + invalidParams.Add(request.NewErrParamRequired("Image")) + } + if s.Env != nil { + for i, v := range s.Env { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Env", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArgs sets the Args field's value. +func (s *EksContainer) SetArgs(v []*string) *EksContainer { + s.Args = v + return s +} + +// SetCommand sets the Command field's value. +func (s *EksContainer) SetCommand(v []*string) *EksContainer { + s.Command = v + return s +} + +// SetEnv sets the Env field's value. +func (s *EksContainer) SetEnv(v []*EksContainerEnvironmentVariable) *EksContainer { + s.Env = v + return s +} + +// SetImage sets the Image field's value. +func (s *EksContainer) SetImage(v string) *EksContainer { + s.Image = &v + return s +} + +// SetImagePullPolicy sets the ImagePullPolicy field's value. +func (s *EksContainer) SetImagePullPolicy(v string) *EksContainer { + s.ImagePullPolicy = &v + return s +} + +// SetName sets the Name field's value. +func (s *EksContainer) SetName(v string) *EksContainer { + s.Name = &v + return s +} + +// SetResources sets the Resources field's value. +func (s *EksContainer) SetResources(v *EksContainerResourceRequirements) *EksContainer { + s.Resources = v + return s +} + +// SetSecurityContext sets the SecurityContext field's value. +func (s *EksContainer) SetSecurityContext(v *EksContainerSecurityContext) *EksContainer { + s.SecurityContext = v + return s +} + +// SetVolumeMounts sets the VolumeMounts field's value. +func (s *EksContainer) SetVolumeMounts(v []*EksContainerVolumeMount) *EksContainer { + s.VolumeMounts = v + return s +} + +// The details for container properties that are returned by DescribeJobs for +// jobs that use Amazon EKS. +type EksContainerDetail struct { + _ struct{} `type:"structure"` + + // An array of arguments to the entrypoint. If this isn't specified, the CMD + // of the container image is used. This corresponds to the args member in the + // Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // portion of the Pod (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) + // 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 changed. For example, if the reference is to "$(NAME1)" and + // the NAME1 environment variable doesn't exist, the command string will remain + // "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. + // For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME + // environment variable exists. For more information, see CMD (https://docs.docker.com/engine/reference/builder/#cmd) + // in the Dockerfile reference and Define a command and arguments for a pod + // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // in the Kubernetes documentation. + Args []*string `locationName:"args" type:"list"` + + // The entrypoint for the container. For more information, see Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // in the Kubernetes documentation. + Command []*string `locationName:"command" type:"list"` + + // The environment variables to pass to a container. + // + // Environment variables cannot start with "AWS_BATCH". This naming convention + // is reserved for variables that Batch sets. + Env []*EksContainerEnvironmentVariable `locationName:"env" type:"list"` + + // The exit code for the job attempt. A non-zero exit code is considered failed. + ExitCode *int64 `locationName:"exitCode" type:"integer"` + + // The Docker image used to start the container. + Image *string `locationName:"image" type:"string"` + + // The image pull policy for the container. Supported values are Always, IfNotPresent, + // and Never. This parameter defaults to Always if the :latest tag is specified, + // IfNotPresent otherwise. For more information, see Updating images (https://kubernetes.io/docs/concepts/containers/images/#updating-images) + // in the Kubernetes documentation. + ImagePullPolicy *string `locationName:"imagePullPolicy" type:"string"` + + // The name of the container. If the name isn't specified, the default name + // "Default" is used. Each container in a pod must have a unique name. + Name *string `locationName:"name" type:"string"` + + // A short human-readable string to provide additional details for a running + // or stopped container. It can be up to 255 characters long. + Reason *string `locationName:"reason" type:"string"` + + // The type and amount of resources to assign to a container. The supported + // resources include memory, cpu, and nvidia.com/gpu. For more information, + // see Resource management for pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) + // in the Kubernetes documentation. + Resources *EksContainerResourceRequirements `locationName:"resources" type:"structure"` + + // The security context for a job. For more information, see Configure a security + // context for a pod or container (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) + // in the Kubernetes documentation. + SecurityContext *EksContainerSecurityContext `locationName:"securityContext" type:"structure"` + + // The volume mounts for the container. Batch supports emptyDir, hostPath, and + // secret volume types. For more information about volumes and volume mounts + // in Kubernetes, see Volumes (https://kubernetes.io/docs/concepts/storage/volumes/) + // in the Kubernetes documentation. + VolumeMounts []*EksContainerVolumeMount `locationName:"volumeMounts" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerDetail) GoString() string { + return s.String() +} + +// SetArgs sets the Args field's value. +func (s *EksContainerDetail) SetArgs(v []*string) *EksContainerDetail { + s.Args = v + return s +} + +// SetCommand sets the Command field's value. +func (s *EksContainerDetail) SetCommand(v []*string) *EksContainerDetail { + s.Command = v + return s +} + +// SetEnv sets the Env field's value. +func (s *EksContainerDetail) SetEnv(v []*EksContainerEnvironmentVariable) *EksContainerDetail { + s.Env = v + return s +} + +// SetExitCode sets the ExitCode field's value. +func (s *EksContainerDetail) SetExitCode(v int64) *EksContainerDetail { + s.ExitCode = &v + return s +} + +// SetImage sets the Image field's value. +func (s *EksContainerDetail) SetImage(v string) *EksContainerDetail { + s.Image = &v + return s +} + +// SetImagePullPolicy sets the ImagePullPolicy field's value. +func (s *EksContainerDetail) SetImagePullPolicy(v string) *EksContainerDetail { + s.ImagePullPolicy = &v + return s +} + +// SetName sets the Name field's value. +func (s *EksContainerDetail) SetName(v string) *EksContainerDetail { + s.Name = &v + return s +} + +// SetReason sets the Reason field's value. +func (s *EksContainerDetail) SetReason(v string) *EksContainerDetail { + s.Reason = &v + return s +} + +// SetResources sets the Resources field's value. +func (s *EksContainerDetail) SetResources(v *EksContainerResourceRequirements) *EksContainerDetail { + s.Resources = v + return s +} + +// SetSecurityContext sets the SecurityContext field's value. +func (s *EksContainerDetail) SetSecurityContext(v *EksContainerSecurityContext) *EksContainerDetail { + s.SecurityContext = v + return s +} + +// SetVolumeMounts sets the VolumeMounts field's value. +func (s *EksContainerDetail) SetVolumeMounts(v []*EksContainerVolumeMount) *EksContainerDetail { + s.VolumeMounts = v + return s +} + +// An environment variable. +type EksContainerEnvironmentVariable struct { + _ struct{} `type:"structure"` + + // The name of the environment variable. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The value of the environment variable. + Value *string `locationName:"value" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerEnvironmentVariable) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerEnvironmentVariable) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksContainerEnvironmentVariable) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksContainerEnvironmentVariable"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *EksContainerEnvironmentVariable) SetName(v string) *EksContainerEnvironmentVariable { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *EksContainerEnvironmentVariable) SetValue(v string) *EksContainerEnvironmentVariable { + s.Value = &v + return s +} + +// Object representing any Kubernetes overrides to a job definition that's used +// in a SubmitJob API operation. +type EksContainerOverride struct { + _ struct{} `type:"structure"` + + // The arguments to the entrypoint to send to the container that overrides the + // default arguments from the Docker image or the job definition. For more information, + // see CMD (https://docs.docker.com/engine/reference/builder/#cmd) in the Dockerfile + // reference and Define a command an arguments for a pod (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // in the Kubernetes documentation. + Args []*string `locationName:"args" type:"list"` + + // The command to send to the container that overrides the default command from + // the Docker image or the job definition. + Command []*string `locationName:"command" type:"list"` + + // The environment variables to send to the container. You can add new environment + // variables, which are added to the container at launch. Or, you can override + // the existing environment variables from the Docker image or the job definition. + // + // Environment variables cannot start with "AWS_BATCH". This naming convention + // is reserved for variables that Batch sets. + Env []*EksContainerEnvironmentVariable `locationName:"env" type:"list"` + + // The override of the Docker image that's used to start the container. + Image *string `locationName:"image" type:"string"` + + // The type and amount of resources to assign to a container. These override + // the settings in the job definition. The supported resources include memory, + // cpu, and nvidia.com/gpu. For more information, see Resource management for + // pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) + // in the Kubernetes documentation. + Resources *EksContainerResourceRequirements `locationName:"resources" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerOverride) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerOverride) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksContainerOverride) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksContainerOverride"} + if s.Env != nil { + for i, v := range s.Env { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Env", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArgs sets the Args field's value. +func (s *EksContainerOverride) SetArgs(v []*string) *EksContainerOverride { + s.Args = v + return s +} + +// SetCommand sets the Command field's value. +func (s *EksContainerOverride) SetCommand(v []*string) *EksContainerOverride { + s.Command = v + return s +} + +// SetEnv sets the Env field's value. +func (s *EksContainerOverride) SetEnv(v []*EksContainerEnvironmentVariable) *EksContainerOverride { + s.Env = v + return s +} + +// SetImage sets the Image field's value. +func (s *EksContainerOverride) SetImage(v string) *EksContainerOverride { + s.Image = &v + return s +} + +// SetResources sets the Resources field's value. +func (s *EksContainerOverride) SetResources(v *EksContainerResourceRequirements) *EksContainerOverride { + s.Resources = v + return s +} + +// The type and amount of resources to assign to a container. The supported +// resources include memory, cpu, and nvidia.com/gpu. For more information, +// see Resource management for pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) +// in the Kubernetes documentation. +type EksContainerResourceRequirements struct { + _ struct{} `type:"structure"` + + // The type and quantity of the resources to reserve for the container. The + // values vary based on the name that's specified. Resources can be requested + // using either the limits or the requests objects. + // + // memory + // + // The memory hard limit (in MiB) for the container, using whole integers, with + // a "Mi" suffix. If your container attempts to exceed the memory specified, + // the container is terminated. You must specify at least 4 MiB of memory for + // a job. memory can be specified in limits, requests, or both. If memory is + // specified in both places, then the value that's specified in limits must + // be equal to the value that's specified in requests. + // + // To maximize your resource utilization, provide your jobs with as much memory + // as possible for the specific instance type that you are using. To learn how, + // see Memory management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. + // + // cpu + // + // The number of CPUs that's reserved for the container. Values must be an even + // multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu + // is specified in both places, then the value that's specified in limits must + // be at least as large as the value that's specified in requests. + // + // nvidia.com/gpu + // + // The number of GPUs that's reserved for the container. Values must be a whole + // integer. memory can be specified in limits, requests, or both. If memory + // is specified in both places, then the value that's specified in limits must + // be equal to the value that's specified in requests. + Limits map[string]*string `locationName:"limits" type:"map"` + + // The type and quantity of the resources to request for the container. The + // values vary based on the name that's specified. Resources can be requested + // by using either the limits or the requests objects. + // + // memory + // + // The memory hard limit (in MiB) for the container, using whole integers, with + // a "Mi" suffix. If your container attempts to exceed the memory specified, + // the container is terminated. You must specify at least 4 MiB of memory for + // a job. memory can be specified in limits, requests, or both. If memory is + // specified in both, then the value that's specified in limits must be equal + // to the value that's specified in requests. + // + // If you're trying to maximize your resource utilization by providing your + // jobs as much memory as possible for a particular instance type, see Memory + // management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. + // + // cpu + // + // The number of CPUs that are reserved for the container. Values must be an + // even multiple of 0.25. cpu can be specified in limits, requests, or both. + // If cpu is specified in both, then the value that's specified in limits must + // be at least as large as the value that's specified in requests. + // + // nvidia.com/gpu + // + // The number of GPUs that are reserved for the container. Values must be a + // whole integer. nvidia.com/gpu can be specified in limits, requests, or both. + // If nvidia.com/gpu is specified in both, then the value that's specified in + // limits must be equal to the value that's specified in requests. + Requests map[string]*string `locationName:"requests" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerResourceRequirements) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerResourceRequirements) GoString() string { + return s.String() +} + +// SetLimits sets the Limits field's value. +func (s *EksContainerResourceRequirements) SetLimits(v map[string]*string) *EksContainerResourceRequirements { + s.Limits = v + return s +} + +// SetRequests sets the Requests field's value. +func (s *EksContainerResourceRequirements) SetRequests(v map[string]*string) *EksContainerResourceRequirements { + s.Requests = v + return s +} + +// The security context for a job. For more information, see Configure a security +// context for a pod or container (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) +// in the Kubernetes documentation. +type EksContainerSecurityContext struct { + _ struct{} `type:"structure"` + + // When this parameter is true, the container is given elevated permissions + // on the host container instance. The level of permissions are similar to the + // root user permissions. The default value is false. This parameter maps to + // privileged policy in the Privileged pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged) + // in the Kubernetes documentation. + Privileged *bool `locationName:"privileged" type:"boolean"` + + // When this parameter is true, the container is given read-only access to its + // root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem + // policy in the Volumes and file systems pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems) + // in the Kubernetes documentation. + ReadOnlyRootFilesystem *bool `locationName:"readOnlyRootFilesystem" type:"boolean"` + + // When this parameter is specified, the container is run as the specified group + // ID (gid). If this parameter isn't specified, the default is the group that's + // specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs + // policy in the Users and groups pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) + // in the Kubernetes documentation. + RunAsGroup *int64 `locationName:"runAsGroup" type:"long"` + + // When this parameter is specified, the container is run as a user with a uid + // other than 0. If this parameter isn't specified, so such rule is enforced. + // This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users + // and groups pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) + // in the Kubernetes documentation. + RunAsNonRoot *bool `locationName:"runAsNonRoot" type:"boolean"` + + // When this parameter is specified, the container is run as the specified user + // ID (uid). If this parameter isn't specified, the default is the user that's + // specified in the image metadata. This parameter maps to RunAsUser and MustRanAs + // policy in the Users and groups pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) + // in the Kubernetes documentation. + RunAsUser *int64 `locationName:"runAsUser" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerSecurityContext) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerSecurityContext) GoString() string { + return s.String() +} + +// SetPrivileged sets the Privileged field's value. +func (s *EksContainerSecurityContext) SetPrivileged(v bool) *EksContainerSecurityContext { + s.Privileged = &v + return s +} + +// SetReadOnlyRootFilesystem sets the ReadOnlyRootFilesystem field's value. +func (s *EksContainerSecurityContext) SetReadOnlyRootFilesystem(v bool) *EksContainerSecurityContext { + s.ReadOnlyRootFilesystem = &v + return s +} + +// SetRunAsGroup sets the RunAsGroup field's value. +func (s *EksContainerSecurityContext) SetRunAsGroup(v int64) *EksContainerSecurityContext { + s.RunAsGroup = &v + return s +} + +// SetRunAsNonRoot sets the RunAsNonRoot field's value. +func (s *EksContainerSecurityContext) SetRunAsNonRoot(v bool) *EksContainerSecurityContext { + s.RunAsNonRoot = &v + return s +} + +// SetRunAsUser sets the RunAsUser field's value. +func (s *EksContainerSecurityContext) SetRunAsUser(v int64) *EksContainerSecurityContext { + s.RunAsUser = &v + return s +} + +// The volume mounts for a container for an Amazon EKS job. For more information +// about volumes and volume mounts in Kubernetes, see Volumes (https://kubernetes.io/docs/concepts/storage/volumes/) +// in the Kubernetes documentation. +type EksContainerVolumeMount struct { + _ struct{} `type:"structure"` + + // The path on the container where the volume is mounted. + MountPath *string `locationName:"mountPath" type:"string"` + + // The name the volume mount. This must match the name of one of the volumes + // in the pod. + Name *string `locationName:"name" type:"string"` + + // If this value is true, the container has read-only access to the volume. + // Otherwise, the container can write to the volume. The default value is false. + ReadOnly *bool `locationName:"readOnly" type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerVolumeMount) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksContainerVolumeMount) GoString() string { + return s.String() +} + +// SetMountPath sets the MountPath field's value. +func (s *EksContainerVolumeMount) SetMountPath(v string) *EksContainerVolumeMount { + s.MountPath = &v + return s +} + +// SetName sets the Name field's value. +func (s *EksContainerVolumeMount) SetName(v string) *EksContainerVolumeMount { + s.Name = &v + return s +} + +// SetReadOnly sets the ReadOnly field's value. +func (s *EksContainerVolumeMount) SetReadOnly(v bool) *EksContainerVolumeMount { + s.ReadOnly = &v + return s +} + +// Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir +// volume is first created when a pod is assigned to a node. It exists as long +// as that pod is running on that node. The emptyDir volume is initially empty. +// All containers in the pod can read and write the files in the emptyDir volume. +// However, the emptyDir volume can be mounted at the same or different paths +// in each container. When a pod is removed from a node for any reason, the +// data in the emptyDir is deleted permanently. For more information, see emptyDir +// (https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) in the Kubernetes +// documentation. +type EksEmptyDir struct { + _ struct{} `type:"structure"` + + // The medium to store the volume. The default value is an empty string, which + // uses the storage of the node. + // + // "" + // + // (Default) Use the disk storage of the node. + // + // "Memory" + // + // Use the tmpfs volume that's backed by the RAM of the node. Contents of the + // volume are lost when the node reboots, and any storage on the volume counts + // against the container's memory limit. + Medium *string `locationName:"medium" type:"string"` + + // The maximum size of the volume. By default, there's no maximum size defined. + SizeLimit *string `locationName:"sizeLimit" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksEmptyDir) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksEmptyDir) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksEmptyDir) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksEmptyDir"} + if s.SizeLimit != nil && len(*s.SizeLimit) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SizeLimit", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMedium sets the Medium field's value. +func (s *EksEmptyDir) SetMedium(v string) *EksEmptyDir { + s.Medium = &v + return s +} + +// SetSizeLimit sets the SizeLimit field's value. +func (s *EksEmptyDir) SetSizeLimit(v string) *EksEmptyDir { + s.SizeLimit = &v + return s +} + +// Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume +// mounts an existing file or directory from the host node's filesystem into +// your pod. For more information, see hostPath (https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) +// in the Kubernetes documentation. +type EksHostPath struct { + _ struct{} `type:"structure"` + + // The path of the file or directory on the host to mount into containers on + // the pod. + Path *string `locationName:"path" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksHostPath) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksHostPath) GoString() string { + return s.String() +} + +// SetPath sets the Path field's value. +func (s *EksHostPath) SetPath(v string) *EksHostPath { + s.Path = &v + return s +} + +// The properties for the pod. +type EksPodProperties struct { + _ struct{} `type:"structure"` + + // The properties of the container that's used on the Amazon EKS pod. + Containers []*EksContainer `locationName:"containers" type:"list"` + + // The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork + // parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst + // indicates that any DNS query that does not match the configured cluster domain + // suffix is forwarded to the upstream nameserver inherited from the node. For + // more information, see Pod's DNS policy (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) + // in the Kubernetes documentation. + // + // Valid values: Default | ClusterFirst | ClusterFirstWithHostNet | None + DnsPolicy *string `locationName:"dnsPolicy" type:"string"` + + // Indicates if the pod uses the hosts' network IP address. The default value + // is true. Setting this to false enables the Kubernetes pod networking model. + // Most Batch workloads are egress-only and don't require the overhead of IP + // allocation for each pod for incoming connections. For more information, see + // Host namespaces (https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) + // and Pod networking (https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) + // in the Kubernetes documentation. + HostNetwork *bool `locationName:"hostNetwork" type:"boolean"` + + // The name of the service account that's used to run the pod. For more information, + // see Kubernetes service accounts (https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) + // and Configure a Kubernetes service account to assume an IAM role (https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) + // in the Amazon EKS User Guide and Configure service accounts for pods (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) + // in the Kubernetes documentation. + ServiceAccountName *string `locationName:"serviceAccountName" type:"string"` + + // Specifies the volumes for a job definition that uses Amazon EKS resources. + Volumes []*EksVolume `locationName:"volumes" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPodProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPodProperties) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksPodProperties) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksPodProperties"} + if s.Containers != nil { + for i, v := range s.Containers { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Containers", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Volumes != nil { + for i, v := range s.Volumes { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Volumes", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContainers sets the Containers field's value. +func (s *EksPodProperties) SetContainers(v []*EksContainer) *EksPodProperties { + s.Containers = v + return s +} + +// SetDnsPolicy sets the DnsPolicy field's value. +func (s *EksPodProperties) SetDnsPolicy(v string) *EksPodProperties { + s.DnsPolicy = &v + return s +} + +// SetHostNetwork sets the HostNetwork field's value. +func (s *EksPodProperties) SetHostNetwork(v bool) *EksPodProperties { + s.HostNetwork = &v + return s +} + +// SetServiceAccountName sets the ServiceAccountName field's value. +func (s *EksPodProperties) SetServiceAccountName(v string) *EksPodProperties { + s.ServiceAccountName = &v + return s +} + +// SetVolumes sets the Volumes field's value. +func (s *EksPodProperties) SetVolumes(v []*EksVolume) *EksPodProperties { + s.Volumes = v + return s +} + +// The details for the pod. +type EksPodPropertiesDetail struct { + _ struct{} `type:"structure"` + + // The properties of the container that's used on the Amazon EKS pod. + Containers []*EksContainerDetail `locationName:"containers" type:"list"` + + // The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork + // parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst + // indicates that any DNS query that does not match the configured cluster domain + // suffix is forwarded to the upstream nameserver inherited from the node. For + // more information, see Pod's DNS policy (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) + // in the Kubernetes documentation. + // + // Valid values: Default | ClusterFirst | ClusterFirstWithHostNet | None + DnsPolicy *string `locationName:"dnsPolicy" type:"string"` + + // Indicates if the pod uses the hosts' network IP address. The default value + // is true. Setting this to false enables the Kubernetes pod networking model. + // Most Batch workloads are egress-only and don't require the overhead of IP + // allocation for each pod for incoming connections. For more information, see + // Host namespaces (https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) + // and Pod networking (https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) + // in the Kubernetes documentation. + HostNetwork *bool `locationName:"hostNetwork" type:"boolean"` + + // The name of the node for this job. + NodeName *string `locationName:"nodeName" type:"string"` + + // The name of the pod for this job. + PodName *string `locationName:"podName" type:"string"` + + // The name of the service account that's used to run the pod. For more information, + // see Kubernetes service accounts (https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) + // and Configure a Kubernetes service account to assume an IAM role (https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) + // in the Amazon EKS User Guide and Configure service accounts for pods (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) + // in the Kubernetes documentation. + ServiceAccountName *string `locationName:"serviceAccountName" type:"string"` + + // Specifies the volumes for a job definition using Amazon EKS resources. + Volumes []*EksVolume `locationName:"volumes" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPodPropertiesDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPodPropertiesDetail) GoString() string { + return s.String() +} + +// SetContainers sets the Containers field's value. +func (s *EksPodPropertiesDetail) SetContainers(v []*EksContainerDetail) *EksPodPropertiesDetail { + s.Containers = v + return s +} + +// SetDnsPolicy sets the DnsPolicy field's value. +func (s *EksPodPropertiesDetail) SetDnsPolicy(v string) *EksPodPropertiesDetail { + s.DnsPolicy = &v + return s +} + +// SetHostNetwork sets the HostNetwork field's value. +func (s *EksPodPropertiesDetail) SetHostNetwork(v bool) *EksPodPropertiesDetail { + s.HostNetwork = &v + return s +} + +// SetNodeName sets the NodeName field's value. +func (s *EksPodPropertiesDetail) SetNodeName(v string) *EksPodPropertiesDetail { + s.NodeName = &v + return s +} + +// SetPodName sets the PodName field's value. +func (s *EksPodPropertiesDetail) SetPodName(v string) *EksPodPropertiesDetail { + s.PodName = &v + return s +} + +// SetServiceAccountName sets the ServiceAccountName field's value. +func (s *EksPodPropertiesDetail) SetServiceAccountName(v string) *EksPodPropertiesDetail { + s.ServiceAccountName = &v + return s +} + +// SetVolumes sets the Volumes field's value. +func (s *EksPodPropertiesDetail) SetVolumes(v []*EksVolume) *EksPodPropertiesDetail { + s.Volumes = v + return s +} + +// An object that contains overrides for the Kubernetes pod properties of a +// job. +type EksPodPropertiesOverride struct { + _ struct{} `type:"structure"` + + // The overrides for the container that's used on the Amazon EKS pod. + Containers []*EksContainerOverride `locationName:"containers" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPodPropertiesOverride) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPodPropertiesOverride) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksPodPropertiesOverride) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksPodPropertiesOverride"} + if s.Containers != nil { + for i, v := range s.Containers { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Containers", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContainers sets the Containers field's value. +func (s *EksPodPropertiesOverride) SetContainers(v []*EksContainerOverride) *EksPodPropertiesOverride { + s.Containers = v + return s +} + +// An object that contains the properties for the Kubernetes resources of a +// job. +type EksProperties struct { + _ struct{} `type:"structure"` + + // The properties for the Kubernetes pod resources of a job. + PodProperties *EksPodProperties `locationName:"podProperties" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksProperties) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksProperties) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksProperties"} + if s.PodProperties != nil { + if err := s.PodProperties.Validate(); err != nil { + invalidParams.AddNested("PodProperties", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPodProperties sets the PodProperties field's value. +func (s *EksProperties) SetPodProperties(v *EksPodProperties) *EksProperties { + s.PodProperties = v + return s +} + +// An object that contains the details for the Kubernetes resources of a job. +type EksPropertiesDetail struct { + _ struct{} `type:"structure"` + + // The properties for the Kubernetes pod resources of a job. + PodProperties *EksPodPropertiesDetail `locationName:"podProperties" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPropertiesDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EksPropertiesDetail) GoString() string { + return s.String() +} + +// SetPodProperties sets the PodProperties field's value. +func (s *EksPropertiesDetail) SetPodProperties(v *EksPodPropertiesDetail) *EksPropertiesDetail { + s.PodProperties = v return s } -// The authorization configuration details for the Amazon EFS file system. -type EFSAuthorizationConfig struct { +// An object that contains overrides for the Kubernetes resources of a job. +type EksPropertiesOverride struct { _ struct{} `type:"structure"` - // The Amazon EFS access point ID to use. If an access point is specified, the - // root directory value specified in the EFSVolumeConfiguration must either - // be omitted or set to / which will enforce the path set on the EFS access - // point. If an access point is used, transit encryption must be enabled in - // the EFSVolumeConfiguration. For more information, see Working with Amazon - // EFS access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) - // in the Amazon Elastic File System User Guide. - AccessPointId *string `locationName:"accessPointId" type:"string"` - - // Whether or not to use the Batch job IAM role defined in a job definition - // when mounting the Amazon EFS file system. If enabled, transit encryption - // must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, - // the default value of DISABLED is used. For more information, see Using Amazon - // EFS access points (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) - // in the Batch User Guide. EFS IAM authorization requires that TransitEncryption - // be ENABLED and that a JobRoleArn is specified. - Iam *string `locationName:"iam" type:"string" enum:"EFSAuthorizationConfigIAM"` + // The overrides for the Kubernetes pod resources of a job. + PodProperties *EksPodPropertiesOverride `locationName:"podProperties" type:"structure"` } // String returns the string representation. @@ -6228,7 +7965,7 @@ type EFSAuthorizationConfig struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EFSAuthorizationConfig) String() string { +func (s EksPropertiesOverride) String() string { return awsutil.Prettify(s) } @@ -6237,61 +7974,46 @@ func (s EFSAuthorizationConfig) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EFSAuthorizationConfig) GoString() string { +func (s EksPropertiesOverride) GoString() string { return s.String() } -// SetAccessPointId sets the AccessPointId field's value. -func (s *EFSAuthorizationConfig) SetAccessPointId(v string) *EFSAuthorizationConfig { - s.AccessPointId = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksPropertiesOverride) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksPropertiesOverride"} + if s.PodProperties != nil { + if err := s.PodProperties.Validate(); err != nil { + invalidParams.AddNested("PodProperties", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetIam sets the Iam field's value. -func (s *EFSAuthorizationConfig) SetIam(v string) *EFSAuthorizationConfig { - s.Iam = &v +// SetPodProperties sets the PodProperties field's value. +func (s *EksPropertiesOverride) SetPodProperties(v *EksPodPropertiesOverride) *EksPropertiesOverride { + s.PodProperties = v return s } -// This is used when you're using an Amazon Elastic File System file system -// for job storage. For more information, see Amazon EFS Volumes (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) -// in the Batch User Guide. -type EFSVolumeConfiguration struct { +// Specifies the configuration of a Kubernetes secret volume. For more information, +// see secret (https://kubernetes.io/docs/concepts/storage/volumes/#secret) +// in the Kubernetes documentation. +type EksSecret struct { _ struct{} `type:"structure"` - // The authorization configuration details for the Amazon EFS file system. - AuthorizationConfig *EFSAuthorizationConfig `locationName:"authorizationConfig" type:"structure"` - - // The Amazon EFS file system ID to use. - // - // FileSystemId is a required field - FileSystemId *string `locationName:"fileSystemId" type:"string" required:"true"` + // Specifies whether the secret or the secret's keys must be defined. + Optional *bool `locationName:"optional" type:"boolean"` - // The directory within the Amazon EFS file system to mount as the root directory - // inside the host. If this parameter is omitted, the root of the Amazon EFS - // volume is used instead. Specifying / has the same effect as omitting this - // parameter. The maximum length is 4,096 characters. + // The name of the secret. The name must be allowed as a DNS subdomain name. + // For more information, see DNS subdomain names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) + // in the Kubernetes documentation. // - // If an EFS access point is specified in the authorizationConfig, the root - // directory parameter must either be omitted or set to /, which enforces the - // path set on the Amazon EFS access point. - RootDirectory *string `locationName:"rootDirectory" type:"string"` - - // Determines whether to enable encryption for Amazon EFS data in transit between - // the Amazon ECS host and the Amazon EFS server. Transit encryption must be - // enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, - // the default value of DISABLED is used. For more information, see Encrypting - // data in transit (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) - // in the Amazon Elastic File System User Guide. - TransitEncryption *string `locationName:"transitEncryption" type:"string" enum:"EFSTransitEncryption"` - - // The port to use when sending encrypted data between the Amazon ECS host and - // the Amazon EFS server. If you don't specify a transit encryption port, it - // uses the port selection strategy that the Amazon EFS mount helper uses. The - // value must be between 0 and 65,535. For more information, see EFS mount helper - // (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the - // Amazon Elastic File System User Guide. - TransitEncryptionPort *int64 `locationName:"transitEncryptionPort" type:"integer"` + // SecretName is a required field + SecretName *string `locationName:"secretName" type:"string" required:"true"` } // String returns the string representation. @@ -6299,7 +8021,7 @@ type EFSVolumeConfiguration struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EFSVolumeConfiguration) String() string { +func (s EksSecret) String() string { return awsutil.Prettify(s) } @@ -6308,15 +8030,15 @@ func (s EFSVolumeConfiguration) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EFSVolumeConfiguration) GoString() string { +func (s EksSecret) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *EFSVolumeConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "EFSVolumeConfiguration"} - if s.FileSystemId == nil { - invalidParams.Add(request.NewErrParamRequired("FileSystemId")) +func (s *EksSecret) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksSecret"} + if s.SecretName == nil { + invalidParams.Add(request.NewErrParamRequired("SecretName")) } if invalidParams.Len() > 0 { @@ -6325,84 +8047,43 @@ func (s *EFSVolumeConfiguration) Validate() error { return nil } -// SetAuthorizationConfig sets the AuthorizationConfig field's value. -func (s *EFSVolumeConfiguration) SetAuthorizationConfig(v *EFSAuthorizationConfig) *EFSVolumeConfiguration { - s.AuthorizationConfig = v - return s -} - -// SetFileSystemId sets the FileSystemId field's value. -func (s *EFSVolumeConfiguration) SetFileSystemId(v string) *EFSVolumeConfiguration { - s.FileSystemId = &v +// SetOptional sets the Optional field's value. +func (s *EksSecret) SetOptional(v bool) *EksSecret { + s.Optional = &v return s } -// SetRootDirectory sets the RootDirectory field's value. -func (s *EFSVolumeConfiguration) SetRootDirectory(v string) *EFSVolumeConfiguration { - s.RootDirectory = &v +// SetSecretName sets the SecretName field's value. +func (s *EksSecret) SetSecretName(v string) *EksSecret { + s.SecretName = &v return s } -// SetTransitEncryption sets the TransitEncryption field's value. -func (s *EFSVolumeConfiguration) SetTransitEncryption(v string) *EFSVolumeConfiguration { - s.TransitEncryption = &v - return s -} +// Specifies an Amazon EKS volume for a job definition. +type EksVolume struct { + _ struct{} `type:"structure"` -// SetTransitEncryptionPort sets the TransitEncryptionPort field's value. -func (s *EFSVolumeConfiguration) SetTransitEncryptionPort(v int64) *EFSVolumeConfiguration { - s.TransitEncryptionPort = &v - return s -} + // Specifies the configuration of a Kubernetes emptyDir volume. For more information, + // see emptyDir (https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) + // in the Kubernetes documentation. + EmptyDir *EksEmptyDir `locationName:"emptyDir" type:"structure"` -// Provides information used to select Amazon Machine Images (AMIs) for instances -// in the compute environment. If Ec2Configuration isn't specified, the default -// is ECS_AL2 (Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)). -// -// This object isn't applicable to jobs that are running on Fargate resources. -type Ec2Configuration struct { - _ struct{} `type:"structure"` + // Specifies the configuration of a Kubernetes hostPath volume. For more information, + // see hostPath (https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) + // in the Kubernetes documentation. + HostPath *EksHostPath `locationName:"hostPath" type:"structure"` - // The AMI ID used for instances launched in the compute environment that match - // the image type. This setting overrides the imageId set in the computeResource - // object. + // The name of the volume. The name must be allowed as a DNS subdomain name. + // For more information, see DNS subdomain names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) + // in the Kubernetes documentation. // - // The AMI that you choose for a compute environment must match the architecture - // of the instance types that you intend to use for that compute environment. - // For example, if your compute environment uses A1 instance types, the compute - // resource AMI that you choose must support ARM instances. Amazon ECS vends - // both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. - // For more information, see Amazon ECS-optimized Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) - // in the Amazon Elastic Container Service Developer Guide. - ImageIdOverride *string `locationName:"imageIdOverride" min:"1" type:"string"` + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` - // The image type to match with the instance type to select an AMI. If the imageIdOverride - // parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux - // 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) - // (ECS_AL2) is used. If a new image type is specified in an update, but neither - // an imageId nor a imageIdOverride parameter is specified, then the latest - // Amazon ECS optimized AMI for that image type that's supported by Batch is - // used. - // - // ECS_AL2 - // - // Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)− - // Default for all non-GPU instance families. - // - // ECS_AL2_NVIDIA - // - // Amazon Linux 2 (GPU) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami)−Default - // for all GPU instance families (for example P4 and G4) and can be used for - // all non Amazon Web Services Graviton-based instance types. - // - // ECS_AL1 - // - // Amazon Linux (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami). - // Amazon Linux is reaching the end-of-life of standard support. For more information, - // see Amazon Linux AMI (http://aws.amazon.com/amazon-linux-ami/). - // - // ImageType is a required field - ImageType *string `locationName:"imageType" min:"1" type:"string" required:"true"` + // Specifies the configuration of a Kubernetes secret volume. For more information, + // see secret (https://kubernetes.io/docs/concepts/storage/volumes/#secret) + // in the Kubernetes documentation. + Secret *EksSecret `locationName:"secret" type:"structure"` } // String returns the string representation. @@ -6410,7 +8091,7 @@ type Ec2Configuration struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Ec2Configuration) String() string { +func (s EksVolume) String() string { return awsutil.Prettify(s) } @@ -6419,21 +8100,25 @@ func (s Ec2Configuration) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Ec2Configuration) GoString() string { +func (s EksVolume) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *Ec2Configuration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Ec2Configuration"} - if s.ImageIdOverride != nil && len(*s.ImageIdOverride) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ImageIdOverride", 1)) +func (s *EksVolume) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksVolume"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.ImageType == nil { - invalidParams.Add(request.NewErrParamRequired("ImageType")) + if s.EmptyDir != nil { + if err := s.EmptyDir.Validate(); err != nil { + invalidParams.AddNested("EmptyDir", err.(request.ErrInvalidParams)) + } } - if s.ImageType != nil && len(*s.ImageType) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ImageType", 1)) + if s.Secret != nil { + if err := s.Secret.Validate(); err != nil { + invalidParams.AddNested("Secret", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -6442,20 +8127,33 @@ func (s *Ec2Configuration) Validate() error { return nil } -// SetImageIdOverride sets the ImageIdOverride field's value. -func (s *Ec2Configuration) SetImageIdOverride(v string) *Ec2Configuration { - s.ImageIdOverride = &v +// SetEmptyDir sets the EmptyDir field's value. +func (s *EksVolume) SetEmptyDir(v *EksEmptyDir) *EksVolume { + s.EmptyDir = v return s } -// SetImageType sets the ImageType field's value. -func (s *Ec2Configuration) SetImageType(v string) *Ec2Configuration { - s.ImageType = &v +// SetHostPath sets the HostPath field's value. +func (s *EksVolume) SetHostPath(v *EksHostPath) *EksVolume { + s.HostPath = v + return s +} + +// SetName sets the Name field's value. +func (s *EksVolume) SetName(v string) *EksVolume { + s.Name = &v + return s +} + +// SetSecret sets the Secret field's value. +func (s *EksVolume) SetSecret(v *EksSecret) *EksVolume { + s.Secret = v return s } -// Specifies a set of conditions to be met, and an action to take (RETRY or -// EXIT) if all conditions are met. +// Specifies an array of up to 5 conditions to be met, and an action to take +// (RETRY or EXIT) if all conditions are met. If none of the EvaluateOnExit +// conditions in a RetryStrategy match, then the job is retried. type EvaluateOnExit struct { _ struct{} `type:"structure"` @@ -6466,29 +8164,25 @@ type EvaluateOnExit struct { Action *string `locationName:"action" type:"string" required:"true" enum:"RetryAction"` // Contains a glob pattern to match against the decimal representation of the - // ExitCode returned for a job. The pattern can be up to 512 characters in length. - // It can contain only numbers, and can optionally end with an asterisk (*) - // so that only the start of the string needs to be an exact match. + // ExitCode returned for a job. The pattern can be up to 512 characters long. + // It can contain only numbers, and can end with an asterisk (*) so that only + // the start of the string needs to be an exact match. // - // The string can be between 1 and 512 characters in length. + // The string can contain up to 512 characters. OnExitCode *string `locationName:"onExitCode" type:"string"` // Contains a glob pattern to match against the Reason returned for a job. The - // pattern can be up to 512 characters in length. It can contain letters, numbers, + // pattern can contain up to 512 characters. It can contain letters, numbers, // periods (.), colons (:), and white space (including spaces and tabs). It // can optionally end with an asterisk (*) so that only the start of the string // needs to be an exact match. - // - // The string can be between 1 and 512 characters in length. OnReason *string `locationName:"onReason" type:"string"` // Contains a glob pattern to match against the StatusReason returned for a - // job. The pattern can be up to 512 characters in length. It can contain letters, - // numbers, periods (.), colons (:), and white space (including spaces or tabs). + // job. The pattern can contain up to 512 characters. It can contain letters, + // numbers, periods (.), colons (:), and white spaces (including spaces or tabs). // It can optionally end with an asterisk (*) so that only the start of the // string needs to be an exact match. - // - // The string can be between 1 and 512 characters in length. OnStatusReason *string `locationName:"onStatusReason" type:"string"` } @@ -6552,27 +8246,27 @@ type FairsharePolicy struct { _ struct{} `type:"structure"` // A value used to reserve some of the available maximum vCPU for fair share - // identifiers that have not yet been used. + // identifiers that aren't already used. // // The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares // is the number of active fair share identifiers. // - // For example, a computeReservation value of 50 indicates that Batch should - // reserve 50% of the maximum available vCPU if there is only one fair share - // identifier, 25% if there are two fair share identifiers, and 12.5% if there - // are three fair share identifiers. A computeReservation value of 25 indicates - // that Batch should reserve 25% of the maximum available vCPU if there is only - // one fair share identifier, 6.25% if there are two fair share identifiers, - // and 1.56% if there are three fair share identifiers. + // For example, a computeReservation value of 50 indicates that Batchreserves + // 50% of the maximum available vCPU if there's only one fair share identifier. + // It reserves 25% if there are two fair share identifiers. It reserves 12.5% + // if there are three fair share identifiers. A computeReservation value of + // 25 indicates that Batch should reserve 25% of the maximum available vCPU + // if there's only one fair share identifier, 6.25% if there are two fair share + // identifiers, and 1.56% if there are three fair share identifiers. // // The minimum value is 0 and the maximum value is 99. ComputeReservation *int64 `locationName:"computeReservation" type:"integer"` - // The time period to use to calculate a fair share percentage for each fair - // share identifier in use, in seconds. A value of zero (0) indicates that only - // current usage should be measured. The decay allows for more recently run - // jobs to have more weight than jobs that ran earlier. The maximum supported - // value is 604800 (1 week). + // The amount of time (in seconds) to use to calculate a fair share percentage + // for each fair share identifier in use. A value of zero (0) indicates that + // only current usage is measured. The decay allows for more recently run jobs + // to have more weight than jobs that ran earlier. The maximum supported value + // is 604800 (1 week). ShareDecaySeconds *int64 `locationName:"shareDecaySeconds" type:"integer"` // An array of SharedIdentifier objects that contain the weights for the fair @@ -6676,9 +8370,9 @@ func (s *FargatePlatformConfiguration) SetPlatformVersion(v string) *FargatePlat } // Determine whether your data volume persists on the host container instance -// and where it is stored. If this parameter is empty, then the Docker daemon -// assigns a host path for your data volume, but the data isn't guaranteed to -// persist after the containers associated with it stop running. +// and where it's stored. If this parameter is empty, then the Docker daemon +// assigns a host path for your data volume. However, the data isn't guaranteed +// to persist after the containers that are associated with it stop running. type Host struct { _ struct{} `type:"structure"` @@ -6690,8 +8384,8 @@ type Host struct { // container instance, the Docker daemon creates it. If the location does exist, // the contents of the source path folder are exported. // - // This parameter isn't applicable to jobs that run on Fargate resources and - // shouldn't be provided. + // This parameter isn't applicable to jobs that run on Fargate resources. Don't + // provide this for these jobs. SourcePath *string `locationName:"sourcePath" type:"string"` } @@ -6719,13 +8413,24 @@ func (s *Host) SetSourcePath(v string) *Host { return s } -// An object representing an Batch job definition. +// An object that represents an Batch job definition. type JobDefinition struct { _ struct{} `type:"structure"` - // An object with various properties specific to container-based jobs. + // The orchestration type of the compute environment. The valid values are ECS + // (default) or EKS. + ContainerOrchestrationType *string `locationName:"containerOrchestrationType" type:"string" enum:"OrchestrationType"` + + // An object with various properties specific to Amazon ECS based jobs. Valid + // values are containerProperties, eksProperties, and nodeProperties. Only one + // can be specified. ContainerProperties *ContainerProperties `locationName:"containerProperties" type:"structure"` + // An object with various properties that are specific to Amazon EKS based jobs. + // Valid values are containerProperties, eksProperties, and nodeProperties. + // Only one can be specified. + EksProperties *EksProperties `locationName:"eksProperties" type:"structure"` + // The Amazon Resource Name (ARN) for the job definition. // // JobDefinitionArn is a required field @@ -6736,10 +8441,12 @@ type JobDefinition struct { // JobDefinitionName is a required field JobDefinitionName *string `locationName:"jobDefinitionName" type:"string" required:"true"` - // An object with various properties specific to multi-node parallel jobs. + // An object with various properties that are specific to multi-node parallel + // jobs. Valid values are containerProperties, eksProperties, and nodeProperties. + // Only one can be specified. // - // If the job runs on Fargate resources, then you must not specify nodeProperties; - // use containerProperties instead. + // If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties + // instead. NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"` // Default parameters or parameter substitution placeholders that are set in @@ -6756,7 +8463,7 @@ type JobDefinition struct { // Specifies whether to propagate the tags from the job or job definition to // the corresponding Amazon ECS task. If no value is specified, the tags aren't - // propagated. Tags can only be propagated to the tasks during task creation. + // propagated. Tags can only be propagated to the tasks when the tasks are created. // For tags with the same name, job tags are given priority over job definitions // tags. If the total number of combined tags from the job and job definition // is over 50, the job is moved to the FAILED state. @@ -6779,16 +8486,16 @@ type JobDefinition struct { // The status of the job definition. Status *string `locationName:"status" type:"string"` - // The tags applied to the job definition. + // The tags that are applied to the job definition. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` - // The timeout configuration for jobs that are submitted with this job definition. - // You can specify a timeout duration after which Batch terminates your jobs - // if they haven't finished. + // The timeout time for jobs that are submitted with this job definition. After + // the amount of time you specify passes, Batch terminates your jobs if they + // aren't finished. Timeout *JobTimeout `locationName:"timeout" type:"structure"` - // The type of job definition, either container or multinode. If the job is - // run on Fargate resources, then multinode isn't supported. For more information + // The type of job definition. It's either container or multinode. If the job + // is run on Fargate resources, then multinode isn't supported. For more information // about multi-node parallel jobs, see Creating a multi-node parallel job definition // (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) // in the Batch User Guide. @@ -6815,12 +8522,24 @@ func (s JobDefinition) GoString() string { return s.String() } +// SetContainerOrchestrationType sets the ContainerOrchestrationType field's value. +func (s *JobDefinition) SetContainerOrchestrationType(v string) *JobDefinition { + s.ContainerOrchestrationType = &v + return s +} + // SetContainerProperties sets the ContainerProperties field's value. func (s *JobDefinition) SetContainerProperties(v *ContainerProperties) *JobDefinition { s.ContainerProperties = v return s } +// SetEksProperties sets the EksProperties field's value. +func (s *JobDefinition) SetEksProperties(v *EksProperties) *JobDefinition { + s.EksProperties = v + return s +} + // SetJobDefinitionArn sets the JobDefinitionArn field's value. func (s *JobDefinition) SetJobDefinitionArn(v string) *JobDefinition { s.JobDefinitionArn = &v @@ -6899,11 +8618,11 @@ func (s *JobDefinition) SetType(v string) *JobDefinition { return s } -// An object representing an Batch job dependency. +// An object that represents an Batch job dependency. type JobDependency struct { _ struct{} `type:"structure"` - // The job ID of the Batch job associated with this dependency. + // The job ID of the Batch job that's associated with this dependency. JobId *string `locationName:"jobId" type:"string"` // The type of the job dependency. @@ -6940,44 +8659,51 @@ func (s *JobDependency) SetType(v string) *JobDependency { return s } -// An object representing an Batch job. +// An object that represents an Batch job. type JobDetail struct { _ struct{} `type:"structure"` - // The array properties of the job, if it is an array job. + // The array properties of the job, if it's an array job. ArrayProperties *ArrayPropertiesDetail `locationName:"arrayProperties" type:"structure"` - // A list of job attempts associated with this job. + // A list of job attempts that are associated with this job. Attempts []*AttemptDetail `locationName:"attempts" type:"list"` - // An object representing the details of the container that's associated with - // the job. + // An object that represents the details for the container that's associated + // with the job. Container *ContainerDetail `locationName:"container" type:"structure"` // The Unix timestamp (in milliseconds) for when the job was created. For non-array - // jobs and parent array jobs, this is when the job entered the SUBMITTED state - // (at the time SubmitJob was called). For array child jobs, this is when the - // child job was spawned by its parent and entered the PENDING state. + // jobs and parent array jobs, this is when the job entered the SUBMITTED state. + // This is specifically at the time SubmitJob was called. For array child jobs, + // this is when the child job was spawned by its parent and entered the PENDING + // state. CreatedAt *int64 `locationName:"createdAt" type:"long"` // A list of job IDs that this job depends on. DependsOn []*JobDependency `locationName:"dependsOn" type:"list"` + // A list of job attempts that are associated with this job. + EksAttempts []*EksAttemptDetail `locationName:"eksAttempts" type:"list"` + + // An object with various properties that are specific to Amazon EKS based jobs. + // Only one of container, eksProperties, or nodeDetails is specified. + EksProperties *EksPropertiesDetail `locationName:"eksProperties" type:"structure"` + // The Amazon Resource Name (ARN) of the job. JobArn *string `locationName:"jobArn" type:"string"` - // The Amazon Resource Name (ARN) of the job definition that's used by this - // job. + // The Amazon Resource Name (ARN) of the job definition that this job uses. // // JobDefinition is a required field JobDefinition *string `locationName:"jobDefinition" type:"string" required:"true"` - // The ID for the job. + // The job ID. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` - // The name of the job. + // The job name. // // JobName is a required field JobName *string `locationName:"jobName" type:"string" required:"true"` @@ -6988,16 +8714,16 @@ type JobDetail struct { // JobQueue is a required field JobQueue *string `locationName:"jobQueue" type:"string" required:"true"` - // An object representing the details of a node that's associated with a multi-node - // parallel job. + // An object that represents the details of a node that's associated with a + // multi-node parallel job. NodeDetails *NodeDetails `locationName:"nodeDetails" type:"structure"` - // An object representing the node properties of a multi-node parallel job. + // An object that represents the node properties of a multi-node parallel job. // // This isn't applicable to jobs that are running on Fargate resources. NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"` - // Additional parameters passed to the job that replace parameter substitution + // Additional parameters that are passed to the job that replace parameter substitution // placeholders or override any corresponding parameter defaults from the job // definition. Parameters map[string]*string `locationName:"parameters" type:"map"` @@ -7008,7 +8734,7 @@ type JobDetail struct { // Specifies whether to propagate the tags from the job or job definition to // the corresponding Amazon ECS task. If no value is specified, the tags aren't - // propagated. Tags can only be propagated to the tasks during task creation. + // propagated. Tags can only be propagated to the tasks when the tasks are created. // For tags with the same name, job tags are given priority over job definitions // tags. If the total number of combined tags from the job and job definition // is over 50, the job is moved to the FAILED state. @@ -7025,9 +8751,10 @@ type JobDetail struct { // The share identifier for the job. ShareIdentifier *string `locationName:"shareIdentifier" type:"string"` - // The Unix timestamp (in milliseconds) for when the job was started (when the - // job transitioned from the STARTING state to the RUNNING state). This parameter - // isn't provided for child jobs of array jobs or multi-node parallel jobs. + // The Unix timestamp (in milliseconds) for when the job was started. More specifically, + // it's when the job transitioned from the STARTING state to the RUNNING state. + // This parameter isn't provided for child jobs of array jobs or multi-node + // parallel jobs. // // StartedAt is a required field StartedAt *int64 `locationName:"startedAt" type:"long" required:"true"` @@ -7041,16 +8768,16 @@ type JobDetail struct { // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"` - // A short, human-readable string to provide additional details about the current - // status of the job. + // A short, human-readable string to provide more details for the current status + // of the job. StatusReason *string `locationName:"statusReason" type:"string"` - // The Unix timestamp (in milliseconds) for when the job was stopped (when the - // job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED - // or FAILED). + // The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, + // it's when the job transitioned from the RUNNING state to a terminal state, + // such as SUCCEEDED or FAILED. StoppedAt *int64 `locationName:"stoppedAt" type:"long"` - // The tags applied to the job. + // The tags that are applied to the job. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // The timeout configuration for the job. @@ -7105,6 +8832,18 @@ func (s *JobDetail) SetDependsOn(v []*JobDependency) *JobDetail { return s } +// SetEksAttempts sets the EksAttempts field's value. +func (s *JobDetail) SetEksAttempts(v []*EksAttemptDetail) *JobDetail { + s.EksAttempts = v + return s +} + +// SetEksProperties sets the EksProperties field's value. +func (s *JobDetail) SetEksProperties(v *EksPropertiesDetail) *JobDetail { + s.EksProperties = v + return s +} + // SetJobArn sets the JobArn field's value. func (s *JobDetail) SetJobArn(v string) *JobDetail { s.JobArn = &v @@ -7219,7 +8958,7 @@ func (s *JobDetail) SetTimeout(v *JobTimeout) *JobDetail { return s } -// An object representing the details of an Batch job queue. +// An object that represents the details for an Batch job queue. type JobQueueDetail struct { _ struct{} `type:"structure"` @@ -7235,29 +8974,29 @@ type JobQueueDetail struct { // JobQueueArn is a required field JobQueueArn *string `locationName:"jobQueueArn" type:"string" required:"true"` - // The name of the job queue. + // The job queue name. // // JobQueueName is a required field JobQueueName *string `locationName:"jobQueueName" type:"string" required:"true"` // The priority of the job queue. Job queues with a higher priority (or a higher // integer value for the priority parameter) are evaluated first when associated - // with the same compute environment. Priority is determined in descending order, - // for example, a job queue with a priority value of 10 is given scheduling + // with the same compute environment. Priority is determined in descending order. + // For example, a job queue with a priority value of 10 is given scheduling // preference over a job queue with a priority value of 1. All of the compute - // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); + // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). // EC2 and Fargate compute environments can't be mixed. // // Priority is a required field Priority *int64 `locationName:"priority" type:"integer" required:"true"` // The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name - // . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy. + // . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. SchedulingPolicyArn *string `locationName:"schedulingPolicyArn" type:"string"` // Describes the ability of the queue to accept new jobs. If the job queue state - // is ENABLED, it's able to accept jobs. If the job queue state is DISABLED, - // new jobs can't be added to the queue, but jobs already in the queue can finish. + // is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs + // can't be added to the queue, but jobs already in the queue can finish. // // State is a required field State *string `locationName:"state" type:"string" required:"true" enum:"JQState"` @@ -7265,12 +9004,12 @@ type JobQueueDetail struct { // The status of the job queue (for example, CREATING or VALID). Status *string `locationName:"status" type:"string" enum:"JQStatus"` - // A short, human-readable string to provide additional details about the current + // A short, human-readable string to provide additional details for the current // status of the job queue. StatusReason *string `locationName:"statusReason" type:"string"` - // The tags applied to the job queue. For more information, see Tagging your - // Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) + // The tags that are applied to the job queue. For more information, see Tagging + // your Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) // in Batch User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` } @@ -7347,15 +9086,15 @@ func (s *JobQueueDetail) SetTags(v map[string]*string) *JobQueueDetail { return s } -// An object representing summary details of a job. +// An object that represents summary details of a job. type JobSummary struct { _ struct{} `type:"structure"` - // The array properties of the job, if it is an array job. + // The array properties of the job, if it's an array job. ArrayProperties *ArrayPropertiesSummary `locationName:"arrayProperties" type:"structure"` - // An object representing the details of the container that's associated with - // the job. + // An object that represents the details of the container that's associated + // with the job. Container *ContainerSummary `locationName:"container" type:"structure"` // The Unix timestamp (in milliseconds) for when the job was created. For non-array @@ -7370,12 +9109,12 @@ type JobSummary struct { // The Amazon Resource Name (ARN) of the job definition. JobDefinition *string `locationName:"jobDefinition" type:"string"` - // The ID of the job. + // The job ID. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` - // The name of the job. + // The job name. // // JobName is a required field JobName *string `locationName:"jobName" type:"string" required:"true"` @@ -7385,19 +9124,20 @@ type JobSummary struct { // This isn't applicable to jobs that are running on Fargate resources. NodeProperties *NodePropertiesSummary `locationName:"nodeProperties" type:"structure"` - // The Unix timestamp for when the job was started (when the job transitioned - // from the STARTING state to the RUNNING state). + // The Unix timestamp for when the job was started. More specifically, it's + // when the job transitioned from the STARTING state to the RUNNING state. StartedAt *int64 `locationName:"startedAt" type:"long"` // The current status for the job. Status *string `locationName:"status" type:"string" enum:"JobStatus"` - // A short, human-readable string to provide additional details about the current - // status of the job. + // A short, human-readable string to provide more details for the current status + // of the job. StatusReason *string `locationName:"statusReason" type:"string"` - // The Unix timestamp for when the job was stopped (when the job transitioned - // from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED). + // The Unix timestamp for when the job was stopped. More specifically, it's + // when the job transitioned from the RUNNING state to a terminal state, such + // as SUCCEEDED or FAILED. StoppedAt *int64 `locationName:"stoppedAt" type:"long"` } @@ -7491,13 +9231,13 @@ func (s *JobSummary) SetStoppedAt(v int64) *JobSummary { return s } -// An object representing a job timeout configuration. +// An object that represents a job timeout configuration. type JobTimeout struct { _ struct{} `type:"structure"` - // The time duration in seconds (measured from the job attempt's startedAt timestamp) - // after which Batch terminates your jobs if they have not finished. The minimum - // value for the timeout is 60 seconds. + // The job timeout time (in seconds) that's measured from the job attempt's + // startedAt timestamp. After this time passes, Batch terminates your jobs if + // they aren't finished. The minimum value for the timeout is 60 seconds. AttemptDurationSeconds *int64 `locationName:"attemptDurationSeconds" type:"integer"` } @@ -7610,9 +9350,9 @@ func (s *KeyValuesPair) SetValues(v []*string) *KeyValuesPair { return s } -// An object representing a launch template associated with a compute resource. -// You must specify either the launch template ID or launch template name in -// the request, but not both. +// An object that represents a launch template that's associated with a compute +// resource. You must specify either the launch template ID or launch template +// name in the request, but not both. // // If security groups are specified using both the securityGroupIds parameter // of CreateComputeEnvironment and the launch template, the values in the securityGroupIds @@ -7690,20 +9430,20 @@ func (s *LaunchTemplateSpecification) SetVersion(v string) *LaunchTemplateSpecif type LinuxParameters struct { _ struct{} `type:"structure"` - // Any host devices to expose to the container. This parameter maps to Devices - // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // Any of the host devices to expose to the container. This parameter maps to + // Devices in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) // and the --device option to docker run (https://docs.docker.com/engine/reference/run/). // - // This parameter isn't applicable to jobs that are running on Fargate resources - // and shouldn't be provided. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. Devices []*Device `locationName:"devices" type:"list"` // If true, run an init process inside the container that forwards signals and // reaps processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/). // This parameter requires version 1.25 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your - // container instance, log into your container instance and run the following + // container instance, log in to your container instance and run the following // command: sudo docker version | grep "Server API version" InitProcessEnabled *bool `locationName:"initProcessEnabled" type:"boolean"` @@ -7716,34 +9456,34 @@ type LinuxParameters struct { // If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted // values are 0 or any positive integer. If the maxSwap parameter is omitted, // the container doesn't use the swap configuration for the container instance - // it is running on. A maxSwap value must be set for the swappiness parameter + // that it's running on. A maxSwap value must be set for the swappiness parameter // to be used. // - // This parameter isn't applicable to jobs that are running on Fargate resources - // and shouldn't be provided. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. MaxSwap *int64 `locationName:"maxSwap" type:"integer"` // The value for the size (in MiB) of the /dev/shm volume. This parameter maps // to the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/). // - // This parameter isn't applicable to jobs that are running on Fargate resources - // and shouldn't be provided. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. SharedMemorySize *int64 `locationName:"sharedMemorySize" type:"integer"` - // This allows you to tune a container's memory swappiness behavior. A swappiness - // value of 0 causes swapping not to happen unless absolutely necessary. A swappiness - // value of 100 causes pages to be swapped very aggressively. Accepted values - // are whole numbers between 0 and 100. If the swappiness parameter isn't specified, - // a default value of 60 is used. If a value isn't specified for maxSwap, then - // this parameter is ignored. If maxSwap is set to 0, the container doesn't - // use swap. This parameter maps to the --memory-swappiness option to docker - // run (https://docs.docker.com/engine/reference/run/). + // You can use this parameter to tune a container's memory swappiness behavior. + // A swappiness value of 0 causes swapping to not occur unless absolutely necessary. + // A swappiness value of 100 causes pages to be swapped aggressively. Valid + // values are whole numbers between 0 and 100. If the swappiness parameter isn't + // specified, a default value of 60 is used. If a value isn't specified for + // maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container + // doesn't use swap. This parameter maps to the --memory-swappiness option to + // docker run (https://docs.docker.com/engine/reference/run/). // // Consider the following when you use a per-container swap configuration. // // * Swap space must be enabled and allocated on the container instance for - // the containers to use. The Amazon ECS optimized AMIs don't have swap enabled - // by default. You must enable swap on the instance to use this feature. + // the containers to use. By default, the Amazon ECS optimized AMIs don't + // have swap enabled. You must enable swap on the instance to use this feature. // For more information, see Instance store swap volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) // in the Amazon EC2 User Guide for Linux Instances or How do I allocate // memory to work as swap space in an Amazon EC2 instance by using a swap @@ -7753,19 +9493,18 @@ type LinuxParameters struct { // EC2 resources. // // * If the maxSwap and swappiness parameters are omitted from a job definition, - // each container will have a default swappiness value of 60, and the total - // swap usage will be limited to two times the memory reservation of the - // container. + // each container has a default swappiness value of 60. Moreover, the 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 - // and shouldn't be provided. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. Swappiness *int64 `locationName:"swappiness" type:"integer"` // The container path, mount options, and size (in MiB) of the tmpfs mount. // This parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/). // - // This parameter isn't applicable to jobs that are running on Fargate resources - // and shouldn't be provided. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide this parameter for this resource type. Tmpfs []*Tmpfs `locationName:"tmpfs" type:"list"` } @@ -7869,7 +9608,7 @@ type ListJobsInput struct { // JOB_NAME // // The value of the filter is a case-insensitive match for the job name. If - // the value ends with an asterisk (*), the filter will match any job name that + // the value ends with an asterisk (*), the filter matches any job name that // begins with the string before the '*'. This corresponds to the jobName value. // For example, test1 matches both Test1 and test1, and test1* matches both // test1 and Test10. When the JOB_NAME filter is used, the results are grouped @@ -7881,13 +9620,13 @@ type ListJobsInput struct { // job definition. This corresponds to the jobDefinition value. The value is // case sensitive. When the value for the filter is the job definition name, // the results include all the jobs that used any revision of that job definition - // name. If the value ends with an asterisk (*), the filter will match any job + // name. If the value ends with an asterisk (*), the filter matches any job // definition name that begins with the string before the '*'. For example, // jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of // the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION // filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), // the results include jobs that used the specified revision of the job definition. - // Asterisk (*) is not supported when the ARN is used. + // Asterisk (*) isn't supported when the ARN is used. // // BEFORE_CREATED_AT // @@ -7932,8 +9671,8 @@ type ListJobsInput struct { // 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. // - // This token should be treated as an opaque identifier that's only used to - // retrieve the next items in a list and not for other programmatic purposes. + // Treat this token as an opaque identifier that's only used to retrieve the + // next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -8061,8 +9800,8 @@ type ListSchedulingPoliciesInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that's only used to - // retrieve the next items in a list and not for other programmatic purposes. + // Treat this token as an opaque identifier that's only used to retrieve the + // next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -8146,7 +9885,7 @@ type ListTagsForResourceInput struct { // 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, and scheduling policies. ARNs for child jobs - // of array and multi-node parallel (MNP) jobs are not supported. + // of array and multi-node parallel (MNP) jobs aren't supported. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` @@ -8227,9 +9966,9 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe type LogConfiguration struct { _ struct{} `type:"structure"` - // The log driver to use for the container. The valid values listed for this - // parameter are log drivers that the Amazon ECS container agent can communicate - // with by default. + // The log driver to use for the container. The valid values that are listed + // for this parameter are log drivers that the Amazon ECS container agent can + // communicate with by default. // // The supported log drivers are awslogs, fluentd, gelf, json-file, journald, // logentries, syslog, and splunk. @@ -8246,37 +9985,37 @@ type LogConfiguration struct { // // fluentd // - // Specifies the Fluentd logging driver. For more information, including usage + // Specifies the Fluentd logging driver. For more information including usage // and options, see Fluentd logging driver (https://docs.docker.com/config/containers/logging/fluentd/) // in the Docker documentation. // // gelf // - // Specifies the Graylog Extended Format (GELF) logging driver. For more information, + // Specifies the Graylog Extended Format (GELF) logging driver. For more information // including usage and options, see Graylog Extended Format logging driver (https://docs.docker.com/config/containers/logging/gelf/) // in the Docker documentation. // // journald // - // Specifies the journald logging driver. For more information, including usage + // Specifies the journald logging driver. For more information including usage // and options, see Journald logging driver (https://docs.docker.com/config/containers/logging/journald/) // in the Docker documentation. // // json-file // - // Specifies the JSON file logging driver. For more information, including usage + // Specifies the JSON file logging driver. For more information including usage // and options, see JSON File logging driver (https://docs.docker.com/config/containers/logging/json-file/) // in the Docker documentation. // // splunk // - // Specifies the Splunk logging driver. For more information, including usage + // Specifies the Splunk logging driver. For more information including usage // and options, see Splunk logging driver (https://docs.docker.com/config/containers/logging/splunk/) // in the Docker documentation. // // syslog // - // Specifies the syslog logging driver. For more information, including usage + // Specifies the syslog logging driver. For more information including usage // and options, see Syslog logging driver (https://docs.docker.com/config/containers/logging/syslog/) // in the Docker documentation. // @@ -8289,7 +10028,7 @@ type LogConfiguration struct { // // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your - // container instance, log into your container instance and run the following + // container instance, log in to your container instance and run the following // command: sudo docker version | grep "Server API version" // // LogDriver is a required field @@ -8297,8 +10036,8 @@ type LogConfiguration struct { // The configuration options to send to the log driver. This parameter requires // version 1.19 of the Docker Remote API or greater on your container instance. - // To check the Docker Remote API version on your container instance, log into - // your container instance and run the following command: sudo docker version + // To check the Docker Remote API version on your container instance, log in + // to your container instance and run the following command: sudo docker version // | grep "Server API version" Options map[string]*string `locationName:"options" type:"map"` @@ -8367,8 +10106,8 @@ func (s *LogConfiguration) SetSecretOptions(v []*Secret) *LogConfiguration { return s } -// Details on a Docker volume mount point that's used in a job's container properties. -// This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) +// Details for a Docker volume mount point that's used in a job's container +// properties. This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API and the --volume option to docker run. type MountPoint struct { _ struct{} `type:"structure"` @@ -8425,12 +10164,13 @@ func (s *MountPoint) SetSourceVolume(v string) *MountPoint { type NetworkConfiguration struct { _ struct{} `type:"structure"` - // Indicates whether the job should have a public IP address. For a job that - // is running on Fargate resources in a private subnet to send outbound traffic - // to the internet (for example, to pull container images), the private subnet - // requires a NAT gateway be attached to route requests to the internet. For - // more information, see Amazon ECS task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html). - // The default value is "DISABLED". + // Indicates whether the job has a public IP address. For a job that's running + // on Fargate resources in a private subnet to send outbound traffic to the + // internet (for example, to pull container images), the private subnet requires + // a NAT gateway be attached to route requests to the internet. For more information, + // see Amazon ECS task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // in the Amazon Elastic Container Service Developer Guide. The default value + // is "DISABLED". AssignPublicIp *string `locationName:"assignPublicIp" type:"string" enum:"AssignPublicIp"` } @@ -8458,8 +10198,8 @@ func (s *NetworkConfiguration) SetAssignPublicIp(v string) *NetworkConfiguration return s } -// An object representing the elastic network interface for a multi-node parallel -// job node. +// An object that represents the elastic network interface for a multi-node +// parallel job node. type NetworkInterface struct { _ struct{} `type:"structure"` @@ -8509,7 +10249,7 @@ func (s *NetworkInterface) SetPrivateIpv4Address(v string) *NetworkInterface { return s } -// An object representing the details of a multi-node parallel job node. +// An object that represents the details of a multi-node parallel job node. type NodeDetails struct { _ struct{} `type:"structure"` @@ -8517,7 +10257,7 @@ type NodeDetails struct { // job. IsMainNode *bool `locationName:"isMainNode" type:"boolean"` - // The node index for the node. Node index numbering begins at zero. This index + // The node index for the node. Node index numbering starts at zero. This index // is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment // variable. NodeIndex *int64 `locationName:"nodeIndex" type:"integer"` @@ -8553,11 +10293,11 @@ func (s *NodeDetails) SetNodeIndex(v int64) *NodeDetails { return s } -// Object representing any node overrides to a job definition that's used in -// a SubmitJob API operation. +// An object that represents any node overrides to a job definition that's used +// in a SubmitJob API operation. // -// This isn't applicable to jobs that are running on Fargate resources and shouldn't -// be provided; use containerOverrides instead. +// This parameter isn't applicable to jobs that are running on Fargate resources. +// Don't provide it for these jobs. Rather, use containerOverrides instead. type NodeOverrides struct { _ struct{} `type:"structure"` @@ -8566,16 +10306,16 @@ type NodeOverrides struct { // The number of nodes to use with a multi-node parallel job. This value overrides // the number of nodes that are specified in the job definition. To use this - // override: + // override, you must meet the following conditions: // // * There must be at least one node range in your job definition that has - // an open upper boundary (such as : or n:). + // an open upper boundary, such as : or n:. // - // * The lower boundary of the node range specified in the job definition + // * The lower boundary of the node range that's specified in the job definition // must be fewer than the number of nodes specified in the override. // - // * The main node index specified in the job definition must be fewer than - // the number of nodes specified in the override. + // * The main node index that's specified in the job definition must be fewer + // than the number of nodes specified in the override. NumNodes *int64 `locationName:"numNodes" type:"integer"` } @@ -8629,7 +10369,9 @@ func (s *NodeOverrides) SetNumNodes(v int64) *NodeOverrides { return s } -// An object representing the node properties of a multi-node parallel job. +// An object that represents the node properties of a multi-node parallel job. +// +// Node properties can't be specified for Amazon EKS based job definitions. type NodeProperties struct { _ struct{} `type:"structure"` @@ -8639,13 +10381,13 @@ type NodeProperties struct { // MainNode is a required field MainNode *int64 `locationName:"mainNode" type:"integer" required:"true"` - // A list of node ranges and their properties associated with a multi-node parallel - // job. + // A list of node ranges and their properties that are associated with a multi-node + // parallel job. // // NodeRangeProperties is a required field NodeRangeProperties []*NodeRangeProperty `locationName:"nodeRangeProperties" type:"list" required:"true"` - // The number of nodes associated with a multi-node parallel job. + // The number of nodes that are associated with a multi-node parallel job. // // NumNodes is a required field NumNodes *int64 `locationName:"numNodes" type:"integer" required:"true"` @@ -8716,8 +10458,8 @@ func (s *NodeProperties) SetNumNodes(v int64) *NodeProperties { return s } -// An object representing the properties of a node that's associated with a -// multi-node parallel job. +// An object that represents the properties of a node that's associated with +// a multi-node parallel job. type NodePropertiesSummary struct { _ struct{} `type:"structure"` @@ -8730,7 +10472,7 @@ type NodePropertiesSummary struct { // variable. NodeIndex *int64 `locationName:"nodeIndex" type:"integer"` - // The number of nodes associated with a multi-node parallel job. + // The number of nodes that are associated with a multi-node parallel job. NumNodes *int64 `locationName:"numNodes" type:"integer"` } @@ -8770,12 +10512,12 @@ func (s *NodePropertiesSummary) SetNumNodes(v int64) *NodePropertiesSummary { return s } -// Object representing any node overrides to a job definition that's used in -// a SubmitJob API operation. +// The object that represents any node overrides to a job definition that's +// used in a SubmitJob API operation. type NodePropertyOverride struct { _ struct{} `type:"structure"` - // The overrides that should be sent to a node range. + // The overrides that are sent to a node range. ContainerOverrides *ContainerOverrides `locationName:"containerOverrides" type:"structure"` // The range of nodes, using node index values, that's used to override. A range @@ -8836,7 +10578,7 @@ func (s *NodePropertyOverride) SetTargetNodes(v string) *NodePropertyOverride { return s } -// An object representing the properties of the node range for a multi-node +// An object that represents the properties of the node range for a multi-node // parallel job. type NodeRangeProperty struct { _ struct{} `type:"structure"` @@ -8849,7 +10591,7 @@ type NodeRangeProperty struct { // (:n), then 0 is used to start the range. If the ending range value is omitted // (n:), then the highest possible node index is used to end the range. Your // accumulative node ranges must account for all nodes (0:n). You can nest node - // ranges, for example 0:10 and 4:5, in which case the 4:5 range properties + // ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties // override the 0:10 properties. // // TargetNodes is a required field @@ -8908,14 +10650,19 @@ func (s *NodeRangeProperty) SetTargetNodes(v string) *NodeRangeProperty { type RegisterJobDefinitionInput struct { _ struct{} `type:"structure"` - // An object with various properties specific to single-node container-based - // jobs. If the job definition's type parameter is container, then you must - // specify either containerProperties or nodeProperties. + // An object with various properties specific to Amazon ECS based single-node + // container-based jobs. If the job definition's type parameter is container, + // then you must specify either containerProperties or nodeProperties. This + // must not be specified for Amazon EKS based job definitions. // // If the job runs on Fargate resources, then you must not specify nodeProperties; // use only containerProperties. ContainerProperties *ContainerProperties `locationName:"containerProperties" type:"structure"` + // An object with various properties that are specific to Amazon EKS based jobs. + // This must not be specified for Amazon ECS based job definitions. + EksProperties *EksProperties `locationName:"eksProperties" type:"structure"` + // The name of the job definition to register. It can be up to 128 letters long. // It can contain uppercase and lowercase letters, numbers, hyphens (-), and // underscores (_). @@ -8931,6 +10678,8 @@ type RegisterJobDefinitionInput struct { // // If the job runs on Fargate resources, then you must not specify nodeProperties; // use containerProperties instead. + // + // If the job runs on Amazon EKS resources, then you must not specify nodeProperties. NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"` // Default parameter substitution placeholders to set in the job definition. @@ -8941,6 +10690,8 @@ type RegisterJobDefinitionInput struct { // The platform capabilities required by the job definition. If no value is // specified, it defaults to EC2. To run the job on Fargate resources, specify // FARGATE. + // + // If the job runs on Amazon EKS resources, then you must not specify platformCapabilities. PlatformCapabilities []*string `locationName:"platformCapabilities" type:"list" enum:"PlatformCapability"` // Specifies whether to propagate the tags from the job or job definition to @@ -8949,6 +10700,8 @@ type RegisterJobDefinitionInput struct { // For tags with the same name, job tags are given priority over job definitions // tags. If the total number of combined tags from the job 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 propagateTags. PropagateTags *bool `locationName:"propagateTags" type:"boolean"` // The retry strategy to use for failed jobs that are submitted with this job @@ -8958,8 +10711,8 @@ type RegisterJobDefinitionInput struct { RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` // The scheduling priority for jobs that are submitted with this job definition. - // This will only affect jobs in job queues with a fair share policy. Jobs with - // a higher scheduling priority will be scheduled before jobs with a lower scheduling + // This only affects jobs in job queues with a fair share policy. Jobs with + // a higher scheduling priority are scheduled before jobs with a lower scheduling // priority. // // The minimum supported value is 0 and the maximum supported value is 9999. @@ -9025,6 +10778,11 @@ func (s *RegisterJobDefinitionInput) Validate() error { invalidParams.AddNested("ContainerProperties", err.(request.ErrInvalidParams)) } } + if s.EksProperties != nil { + if err := s.EksProperties.Validate(); err != nil { + invalidParams.AddNested("EksProperties", err.(request.ErrInvalidParams)) + } + } if s.NodeProperties != nil { if err := s.NodeProperties.Validate(); err != nil { invalidParams.AddNested("NodeProperties", err.(request.ErrInvalidParams)) @@ -9048,6 +10806,12 @@ func (s *RegisterJobDefinitionInput) SetContainerProperties(v *ContainerProperti return s } +// SetEksProperties sets the EksProperties field's value. +func (s *RegisterJobDefinitionInput) SetEksProperties(v *EksProperties) *RegisterJobDefinitionInput { + s.EksProperties = v + return s +} + // SetJobDefinitionName sets the JobDefinitionName field's value. func (s *RegisterJobDefinitionInput) SetJobDefinitionName(v string) *RegisterJobDefinitionInput { s.JobDefinitionName = &v @@ -9179,11 +10943,12 @@ type ResourceRequirement struct { // // type="GPU" // - // The number of physical GPUs to reserve for the container. The number of GPUs - // reserved for all containers in a job shouldn't exceed the number of available - // GPUs on the compute resource that the job is launched on. + // The number of physical GPUs to reserve for the container. Make sure that + // the number of GPUs reserved for all containers in a job doesn't exceed the + // number of available GPUs on the compute resource that the job is launched + // on. // - // GPUs are not available for jobs that are running on Fargate resources. + // GPUs aren't available for jobs that are running on Fargate resources. // // type="MEMORY" // @@ -9333,8 +11098,8 @@ func (s *ResourceRequirement) SetValue(v string) *ResourceRequirement { return s } -// The retry strategy associated with a job. For more information, see Automated -// job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) +// The retry strategy that's associated with a job. For more information, see +// Automated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) // in the Batch User Guide. type RetryStrategy struct { _ struct{} `type:"structure"` @@ -9344,9 +11109,10 @@ type RetryStrategy struct { // the job is retried on failure the same number of attempts as the value. Attempts *int64 `locationName:"attempts" type:"integer"` - // Array of up to 5 objects that specify conditions under which the job should - // be retried or failed. If this parameter is specified, then the attempts parameter - // must also be specified. + // Array of up to 5 objects that specify the conditions where jobs are retried + // or failed. If this parameter is specified, then the attempts parameter must + // also be specified. If none of the listed conditions match, then the job is + // retried. EvaluateOnExit []*EvaluateOnExit `locationName:"evaluateOnExit" type:"list"` } @@ -9501,8 +11267,8 @@ func (s *SchedulingPolicyListingDetail) SetArn(v string) *SchedulingPolicyListin return s } -// An object representing the secret to expose to your container. Secrets can -// be exposed to a container in the following ways: +// An object that represents the secret to expose to your container. Secrets +// can be exposed to a container in the following ways: // // - To inject sensitive data into your containers as environment variables, // use the secrets container definition parameter. @@ -9521,13 +11287,14 @@ type Secret struct { Name *string `locationName:"name" type:"string" required:"true"` // The secret to expose to the container. The supported values are either the - // full ARN of the Secrets Manager secret or the full ARN of the parameter in - // the Amazon Web Services Systems Manager Parameter Store. + // full Amazon Resource Name (ARN) of the Secrets Manager secret or the full + // ARN of the parameter in the Amazon Web Services Systems Manager Parameter + // Store. // // If the Amazon Web Services Systems Manager Parameter Store parameter exists // in the same Region as the job you're launching, then you can use either the - // full ARN or name of the parameter. If the parameter exists in a different - // Region, then the full ARN must be specified. + // full Amazon Resource Name (ARN) or name of the parameter. If the parameter + // exists in a different Region, then the full ARN must be specified. // // ValueFrom is a required field ValueFrom *string `locationName:"valueFrom" type:"string" required:"true"` @@ -9651,13 +11418,13 @@ type ShareAttributes struct { // A fair share identifier or fair share identifier prefix. If the string ends // with an asterisk (*), this entry specifies the weight factor to use for fair // share identifiers that start with that prefix. The list of fair share identifiers - // in a fair share policy cannot overlap. For example, you can't have one that + // in a fair share policy can't overlap. For example, you can't have one that // specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier // of UserA-1. // // There can be no more than 500 fair share identifiers active in a job queue. // - // The string is limited to 255 alphanumeric characters, optionally followed + // The string is limited to 255 alphanumeric characters, and can be followed // by an asterisk (*). // // ShareIdentifier is a required field @@ -9728,12 +11495,13 @@ type SubmitJobInput struct { // Batch User Guide. ArrayProperties *ArrayProperties `locationName:"arrayProperties" type:"structure"` - // A list of container overrides in the JSON format that specify the name of - // a container in the specified job definition and the overrides it receives. - // You can override the default command for a container, which is specified - // in the job definition or the Docker image, with a command override. You can - // also override existing environment variables on a container or add new environment - // variables to it with an environment override. + // An object with various properties that override the defaults for the job + // definition that specify the name of a container in the specified job definition + // and the overrides it should receive. You can override the default command + // for a container, which is specified in the job definition or the Docker image, + // with a command override. You can also override existing environment variables + // on a container or add new environment variables to it with an environment + // override. ContainerOverrides *ContainerOverrides `locationName:"containerOverrides" type:"structure"` // A list of dependencies for the job. A job can depend upon a maximum of 20 @@ -9745,6 +11513,10 @@ type SubmitJobInput struct { // begin. DependsOn []*JobDependency `locationName:"dependsOn" type:"list"` + // An object that can only be specified for jobs that are run on Amazon EKS + // resources with various properties that override defaults for the job definition. + EksPropertiesOverride *EksPropertiesOverride `locationName:"eksPropertiesOverride" type:"structure"` + // The job definition used by this job. This value can be one of name, name:revision, // or the Amazon Resource Name (ARN) for the job definition. If name is specified // without a revision then the latest active revision is used. @@ -9792,15 +11564,15 @@ type SubmitJobInput struct { // defined in the job definition. RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` - // The scheduling priority for the job. This will only affect jobs in job queues - // with a fair share policy. Jobs with a higher scheduling priority will be - // scheduled before jobs with a lower scheduling priority. This will override - // any scheduling priority in the job definition. + // The scheduling priority for the job. This only affects jobs in job queues + // with a fair share policy. Jobs with a higher scheduling priority are scheduled + // before jobs with a lower scheduling priority. This overrides any scheduling + // priority in the job definition. // // The minimum supported value is 0 and the maximum supported value is 9999. SchedulingPriorityOverride *int64 `locationName:"schedulingPriorityOverride" type:"integer"` - // The share identifier for the job. If the job queue does not have a scheduling + // The share identifier for the job. If the job queue doesn't have a scheduling // policy, then this parameter must not be specified. If the job queue has a // scheduling policy, then this parameter must be specified. ShareIdentifier *string `locationName:"shareIdentifier" type:"string"` @@ -9860,6 +11632,11 @@ func (s *SubmitJobInput) Validate() error { invalidParams.AddNested("ContainerOverrides", err.(request.ErrInvalidParams)) } } + if s.EksPropertiesOverride != nil { + if err := s.EksPropertiesOverride.Validate(); err != nil { + invalidParams.AddNested("EksPropertiesOverride", err.(request.ErrInvalidParams)) + } + } if s.NodeOverrides != nil { if err := s.NodeOverrides.Validate(); err != nil { invalidParams.AddNested("NodeOverrides", err.(request.ErrInvalidParams)) @@ -9895,6 +11672,12 @@ func (s *SubmitJobInput) SetDependsOn(v []*JobDependency) *SubmitJobInput { return s } +// SetEksPropertiesOverride sets the EksPropertiesOverride field's value. +func (s *SubmitJobInput) SetEksPropertiesOverride(v *EksPropertiesOverride) *SubmitJobInput { + s.EksPropertiesOverride = v + return s +} + // SetJobDefinition sets the JobDefinition field's value. func (s *SubmitJobInput) SetJobDefinition(v string) *SubmitJobInput { s.JobDefinition = &v @@ -10021,7 +11804,7 @@ type TagResourceInput struct { // 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, and scheduling policies. ARNs for child jobs of array and multi-node - // parallel (MNP) jobs are not supported. + // parallel (MNP) jobs aren't supported. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` @@ -10357,7 +12140,7 @@ type UntagResourceInput struct { // 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, and scheduling policies. ARNs for child jobs of array and multi-node - // parallel (MNP) jobs are not supported. + // parallel (MNP) jobs aren't supported. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` @@ -10498,10 +12281,10 @@ type UpdateComputeEnvironmentInput struct { State *string `locationName:"state" type:"string" enum:"CEState"` // The maximum number of vCPUs expected to be used for an unmanaged compute - // environment. Do not specify this parameter for a managed compute environment. + // environment. Don't specify this parameter for a managed compute environment. // This parameter is only used for fair share scheduling to reserve vCPU capacity - // for new share identifiers. If this parameter is not provided for a fair share - // job queue, no vCPU capacity will be reserved. + // for new share identifiers. If this parameter isn't provided for a fair share + // job queue, no vCPU capacity is reserved. UnmanagedvCpus *int64 `locationName:"unmanagedvCpus" type:"integer"` // Specifies the updated infrastructure update policy for the compute environment. @@ -10594,9 +12377,9 @@ type UpdateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string"` - // The name of the compute environment. It can be up to 128 letters long. It - // can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores - // (_). + // The name of the compute environment. It can be up to 128 characters long. + // It can contain uppercase and lowercase letters, numbers, hyphens (-), and + // underscores (_). ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string"` } @@ -10664,7 +12447,7 @@ type UpdateJobQueueInput struct { // Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job // queue is created, the fair share scheduling policy can be replaced but not // removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name - // . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy. + // . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. SchedulingPolicyArn *string `locationName:"schedulingPolicyArn" type:"string"` // Describes the queue's ability to accept new jobs. If the job queue state @@ -10791,7 +12574,7 @@ func (s *UpdateJobQueueOutput) SetJobQueueName(v string) *UpdateJobQueueOutput { type UpdatePolicy struct { _ struct{} `type:"structure"` - // Specifies the job timeout, in minutes, when the compute environment infrastructure + // Specifies the job timeout (in minutes) when the compute environment infrastructure // is updated. The default value is 30. JobExecutionTimeoutMinutes *int64 `locationName:"jobExecutionTimeoutMinutes" min:"1" type:"long"` @@ -10926,26 +12709,26 @@ func (s UpdateSchedulingPolicyOutput) GoString() string { return s.String() } -// A data volume used in a job's container properties. +// A data volume that's used in a job's container properties. type Volume struct { _ struct{} `type:"structure"` - // This parameter is specified when you are using an Amazon Elastic File System + // This parameter is specified when you're using an Amazon Elastic File System // file system for job storage. Jobs that are running on Fargate resources must // specify a platformVersion of at least 1.4.0. EfsVolumeConfiguration *EFSVolumeConfiguration `locationName:"efsVolumeConfiguration" type:"structure"` // The contents of the host parameter determine whether your data volume persists - // on the host container instance and where it is stored. If the host parameter + // on the host container instance and where it's stored. If the host parameter // is empty, then the Docker daemon assigns a host path for your data volume. - // However, the data isn't guaranteed to persist after the containers associated - // with it stop running. + // However, the data isn't guaranteed to 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 shouldn't be provided. Host *Host `locationName:"host" type:"structure"` - // The name of the volume. It can be up to 255 letters long. It can contain + // The name of the volume. It can be up to 255 characters long. It can contain // uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). // This name is referenced in the sourceVolume parameter of container definition // mountPoints. @@ -11347,6 +13130,22 @@ func LogDriver_Values() []string { } } +const ( + // OrchestrationTypeEcs is a OrchestrationType enum value + OrchestrationTypeEcs = "ECS" + + // OrchestrationTypeEks is a OrchestrationType enum value + OrchestrationTypeEks = "EKS" +) + +// OrchestrationType_Values returns all elements of the OrchestrationType enum +func OrchestrationType_Values() []string { + return []string{ + OrchestrationTypeEcs, + OrchestrationTypeEks, + } +} + const ( // PlatformCapabilityEc2 is a PlatformCapability enum value PlatformCapabilityEc2 = "EC2" diff --git a/service/batch/doc.go b/service/batch/doc.go index 6a5b0c179c..067e13420a 100644 --- a/service/batch/doc.go +++ b/service/batch/doc.go @@ -6,19 +6,18 @@ // Using Batch, you can run batch computing workloads on the Amazon Web Services // Cloud. Batch computing is a common means for developers, scientists, and // engineers to access large amounts of compute resources. Batch uses the advantages -// of this computing workload to remove the undifferentiated heavy lifting of -// configuring and managing required infrastructure. At the same time, it also -// adopts a familiar batch computing software approach. Given these advantages, -// Batch can help you to efficiently provision resources in response to jobs -// submitted, thus effectively helping you to eliminate capacity constraints, -// reduce compute costs, and deliver your results more quickly. +// of the batch computing to remove the undifferentiated heavy lifting of configuring +// and managing required infrastructure. At the same time, it also adopts a +// familiar batch computing software approach. You can use Batch to efficiently +// provision resources d, and work toward eliminating capacity constraints, +// reducing your overall compute costs, and delivering results more quickly. // // As a fully managed service, Batch can run batch computing workloads of any // scale. Batch automatically provisions compute resources and optimizes workload // distribution based on the quantity and scale of your specific workloads. // With Batch, there's no need to install or manage batch computing software. -// This means that you can focus your time and energy on analyzing results and -// solving your specific problems. +// This means that you can focus on analyzing results and solving your specific +// problems instead. // // See https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10 for more information on this service. // diff --git a/service/batch/errors.go b/service/batch/errors.go index e021720b62..031ebe3ecf 100644 --- a/service/batch/errors.go +++ b/service/batch/errors.go @@ -11,9 +11,10 @@ const ( // ErrCodeClientException for service response error code // "ClientException". // - // These errors are usually caused by a client action, such as using an action - // or resource on behalf of a user that doesn't have permissions to use the - // action or resource, or specifying an identifier that's not valid. + // These errors are usually caused by a client action. One example cause is + // using an action or resource on behalf of a user that doesn't have permissions + // to use the action or resource. Another cause is specifying an identifier + // that's not valid. ErrCodeClientException = "ClientException" // ErrCodeServerException for service response error code diff --git a/service/datasync/api.go b/service/datasync/api.go index 2f958e64a9..3931f67d43 100644 --- a/service/datasync/api.go +++ b/service/datasync/api.go @@ -57,16 +57,15 @@ func (c *DataSync) CancelTaskExecutionRequest(input *CancelTaskExecutionInput) ( // CancelTaskExecution API operation for AWS DataSync. // -// Cancels execution of a task. +// Stops an DataSync task execution that's in progress. The transfer of some +// files are abruptly interrupted. File contents that're transferred to the +// destination might be incomplete or inconsistent with the source files. // -// When you cancel a task execution, the transfer of some files is abruptly -// interrupted. The contents of files that are transferred to the destination -// might be incomplete or inconsistent with the source files. However, if you -// start a new task execution on the same task and you allow the task execution -// to complete, file content on the destination is complete and consistent. +// However, if you start a new task execution using the same task and allow +// it to finish, file content on the destination will be complete and consistent. // This applies to other unexpected failures that interrupt a task execution. -// In all of these cases, DataSync successfully complete the transfer when you -// start the next task execution. +// In all of these cases, DataSync successfully completes the transfer when +// you start the next task execution. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -148,12 +147,12 @@ func (c *DataSync) CreateAgentRequest(input *CreateAgentInput) (req *request.Req // CreateAgent API operation for AWS DataSync. // -// Activates an DataSync agent that you have deployed on your host. The activation -// process associates your agent with your account. In the activation process, -// you specify information such as the Amazon Web Services Region that you want -// to activate the agent in. You activate the agent in the Amazon Web Services -// Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your -// tasks are created in this Amazon Web Services Region. +// Activates an DataSync agent that you have deployed in your storage environment. +// The activation process associates your agent with your account. In the activation +// process, you specify information such as the Amazon Web Services Region that +// you want to activate the agent in. You activate the agent in the Amazon Web +// Services Region where your target locations (in Amazon S3 or Amazon EFS) +// reside. Your tasks are created in this Amazon Web Services Region. // // You can activate the agent in a VPC (virtual private cloud) or provide the // agent access to a VPC endpoint so you can run tasks without going over the @@ -497,7 +496,12 @@ func (c *DataSync) CreateLocationFsxOpenZfsRequest(input *CreateLocationFsxOpenZ // CreateLocationFsxOpenZfs API operation for AWS DataSync. // -// Creates an endpoint for an Amazon FSx for OpenZFS file system. +// Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync +// can access for a transfer. For more information, see Creating a location +// for FSx for OpenZFS (https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html). +// +// Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -910,7 +914,8 @@ func (c *DataSync) CreateLocationS3Request(input *CreateLocationS3Input) (req *r // CreateLocationS3 API operation for AWS DataSync. // -// Creates an endpoint for an Amazon S3 bucket. +// Creates an endpoint for an Amazon S3 bucket that DataSync can access for +// a transfer. // // For more information, see Create an Amazon S3 location (https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli) // in the DataSync User Guide. @@ -1593,8 +1598,8 @@ func (c *DataSync) DescribeLocationFsxLustreRequest(input *DescribeLocationFsxLu // DescribeLocationFsxLustre API operation for AWS DataSync. // -// Returns metadata about an Amazon FSx for Lustre location, such as information -// about its path. +// Provides details about how an DataSync location for an Amazon FSx for Lustre +// file system is configured. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1679,6 +1684,9 @@ func (c *DataSync) DescribeLocationFsxOntapRequest(input *DescribeLocationFsxOnt // Provides details about how an DataSync location for an Amazon FSx for NetApp // ONTAP file system is configured. // +// If your location uses SMB, the DescribeLocationFsxOntap operation doesn't +// actually return a Password. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1759,8 +1767,11 @@ func (c *DataSync) DescribeLocationFsxOpenZfsRequest(input *DescribeLocationFsxO // DescribeLocationFsxOpenZfs API operation for AWS DataSync. // -// Returns metadata about an Amazon FSx for OpenZFS location, such as information -// about its path. +// Provides details about how an DataSync location for an Amazon FSx for OpenZFS +// file system is configured. +// +// Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3719,9 +3730,9 @@ func (c *DataSync) UpdateLocationObjectStorageRequest(input *UpdateLocationObjec // UpdateLocationObjectStorage API operation for AWS DataSync. // -// Updates some of the parameters of a previously created location for self-managed -// object storage server access. For information about creating a self-managed -// object storage location, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). +// Updates some parameters of an existing object storage location that DataSync +// accesses for a transfer. For information about creating a self-managed object +// storage location, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4074,7 +4085,7 @@ func (s *AgentListEntry) SetStatus(v string) *AgentListEntry { type CancelTaskExecutionInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the task execution to cancel. + // The Amazon Resource Name (ARN) of the task execution to stop. // // TaskExecutionArn is a required field TaskExecutionArn *string `type:"string" required:"true"` @@ -5571,6 +5582,15 @@ type CreateLocationObjectStorageInput struct { // String and GoString methods. SecretKey *string `min:"8" type:"string" sensitive:"true"` + // Specifies a certificate to authenticate with an object storage system that + // uses a private or self-signed certificate authority (CA). You must specify + // a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). + // The certificate can be up to 32768 bytes (before Base64 encoding). + // + // To use this parameter, configure ServerProtocol to HTTPS. + // ServerCertificate is automatically base64 encoded/decoded by the SDK. + ServerCertificate []byte `type:"blob"` + // Specifies the domain name or IP address of the object storage server. A DataSync // agent uses this hostname to mount the object storage server in a network. // @@ -5681,6 +5701,12 @@ func (s *CreateLocationObjectStorageInput) SetSecretKey(v string) *CreateLocatio return s } +// SetServerCertificate sets the ServerCertificate field's value. +func (s *CreateLocationObjectStorageInput) SetServerCertificate(v []byte) *CreateLocationObjectStorageInput { + s.ServerCertificate = v + return s +} + // SetServerHostname sets the ServerHostname field's value. func (s *CreateLocationObjectStorageInput) SetServerHostname(v string) *CreateLocationObjectStorageInput { s.ServerHostname = &v @@ -7635,7 +7661,7 @@ type DescribeLocationObjectStorageOutput struct { _ struct{} `type:"structure"` // The access key (for example, a user name) required to authenticate with the - // object storage server. + // object storage system. AccessKey *string `min:"8" type:"string"` // The ARNs of the DataSync agents that can securely connect with your location. @@ -7650,11 +7676,16 @@ type DescribeLocationObjectStorageOutput struct { // The URL of the object storage system location. LocationUri *string `type:"string"` + // The self-signed certificate that DataSync uses to securely authenticate with + // your object storage system. + // ServerCertificate is automatically base64 encoded/decoded by the SDK. + ServerCertificate []byte `type:"blob"` + // The port that your object storage server accepts inbound network traffic // on (for example, port 443). ServerPort *int64 `min:"1" type:"integer"` - // The protocol that your object storage server uses to communicate. + // The protocol that your object storage system uses to communicate. ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"` } @@ -7706,6 +7737,12 @@ func (s *DescribeLocationObjectStorageOutput) SetLocationUri(v string) *Describe return s } +// SetServerCertificate sets the ServerCertificate field's value. +func (s *DescribeLocationObjectStorageOutput) SetServerCertificate(v []byte) *DescribeLocationObjectStorageOutput { + s.ServerCertificate = v + return s +} + // SetServerPort sets the ServerPort field's value. func (s *DescribeLocationObjectStorageOutput) SetServerPort(v int64) *DescribeLocationObjectStorageOutput { s.ServerPort = &v @@ -8041,6 +8078,10 @@ func (s *DescribeTaskExecutionInput) SetTaskExecutionArn(v string) *DescribeTask type DescribeTaskExecutionOutput struct { _ struct{} `type:"structure"` + // The physical number of bytes transferred over the network after compression + // was applied. In most cases, this number is less than BytesTransferred. + BytesCompressed *int64 `type:"long"` + // The physical number of bytes transferred over the network. BytesTransferred *int64 `type:"long"` @@ -8135,6 +8176,12 @@ func (s DescribeTaskExecutionOutput) GoString() string { return s.String() } +// SetBytesCompressed sets the BytesCompressed field's value. +func (s *DescribeTaskExecutionOutput) SetBytesCompressed(v int64) *DescribeTaskExecutionOutput { + s.BytesCompressed = &v + return s +} + // SetBytesTransferred sets the BytesTransferred field's value. func (s *DescribeTaskExecutionOutput) SetBytesTransferred(v int64) *DescribeTaskExecutionOutput { s.BytesTransferred = &v @@ -11422,44 +11469,48 @@ func (s UpdateLocationNfsOutput) GoString() string { type UpdateLocationObjectStorageInput struct { _ struct{} `type:"structure"` - // Optional. The access key is used if credentials are required to access the - // self-managed object storage server. If your object storage requires a user - // name and password to authenticate, use AccessKey and SecretKey to provide - // the user name and password, respectively. + // Specifies the access key (for example, a user name) if credentials are required + // to authenticate with the object storage server. AccessKey *string `min:"8" type:"string"` - // The Amazon Resource Name (ARN) of the agents associated with the self-managed - // object storage server location. + // Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can + // securely connect with your location. AgentArns []*string `min:"1" type:"list"` - // The Amazon Resource Name (ARN) of the self-managed object storage server - // location to be updated. + // Specifies the ARN of the object storage system location that you're updating. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` - // Optional. The secret key is used if credentials are required to access the - // self-managed object storage server. If your object storage requires a user - // name and password to authenticate, use AccessKey and SecretKey to provide - // the user name and password, respectively. + // Specifies the secret key (for example, a password) if credentials are required + // to authenticate with the object storage server. // // SecretKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdateLocationObjectStorageInput's // String and GoString methods. SecretKey *string `min:"8" type:"string" sensitive:"true"` - // The port that your self-managed object storage server accepts inbound network - // traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 - // (HTTPS). You can specify a custom port if your self-managed object storage - // server requires one. + // Specifies a certificate to authenticate with an object storage system that + // uses a private or self-signed certificate authority (CA). You must specify + // a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). + // The certificate can be up to 32768 bytes (before Base64 encoding). + // + // To use this parameter, configure ServerProtocol to HTTPS. + // + // Updating the certificate doesn't interfere with tasks that you have in progress. + // ServerCertificate is automatically base64 encoded/decoded by the SDK. + ServerCertificate []byte `type:"blob"` + + // Specifies the port that your object storage server accepts inbound network + // traffic on (for example, port 443). ServerPort *int64 `min:"1" type:"integer"` - // The protocol that the object storage server uses to communicate. Valid values - // are HTTP or HTTPS. + // Specifies the protocol that your object storage server uses to communicate. ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"` - // The subdirectory in the self-managed object storage server that is used to - // read data from. + // Specifies the object prefix for your object storage server. If this is a + // source location, DataSync only copies objects with this prefix. If this is + // a destination location, DataSync writes all objects with this prefix. Subdirectory *string `type:"string"` } @@ -11530,6 +11581,12 @@ func (s *UpdateLocationObjectStorageInput) SetSecretKey(v string) *UpdateLocatio return s } +// SetServerCertificate sets the ServerCertificate field's value. +func (s *UpdateLocationObjectStorageInput) SetServerCertificate(v []byte) *UpdateLocationObjectStorageInput { + s.ServerCertificate = v + return s +} + // SetServerPort sets the ServerPort field's value. func (s *UpdateLocationObjectStorageInput) SetServerPort(v int64) *UpdateLocationObjectStorageInput { s.ServerPort = &v diff --git a/service/datasync/doc.go b/service/datasync/doc.go index cf3a76c6b9..48964df84b 100644 --- a/service/datasync/doc.go +++ b/service/datasync/doc.go @@ -4,11 +4,12 @@ // requests to AWS DataSync. // // DataSync is a managed data transfer service that makes it simpler for you -// to automate moving data between on-premises storage and Amazon Simple Storage -// Service (Amazon S3) or Amazon Elastic File System (Amazon EFS). +// to automate moving data between on-premises storage and Amazon Web Services +// storage services. You also can use DataSync to transfer data between other +// cloud providers and Amazon Web Services storage services. // -// This API interface reference for DataSync contains documentation for a programming -// interface that you can use to manage DataSync. +// This API interface reference includes documentation for using DataSync programmatically. +// For complete information, see the DataSync User Guide (https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html) . // // See https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09 for more information on this service. // diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index 848b3b7782..76dfdfeb9a 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -16055,6 +16055,139 @@ func (c *SageMaker) ListImagesPagesWithContext(ctx aws.Context, input *ListImage return p.Err() } +const opListInferenceRecommendationsJobSteps = "ListInferenceRecommendationsJobSteps" + +// ListInferenceRecommendationsJobStepsRequest generates a "aws/request.Request" representing the +// client's request for the ListInferenceRecommendationsJobSteps operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListInferenceRecommendationsJobSteps for more information on using the ListInferenceRecommendationsJobSteps +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListInferenceRecommendationsJobStepsRequest method. +// req, resp := client.ListInferenceRecommendationsJobStepsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps +func (c *SageMaker) ListInferenceRecommendationsJobStepsRequest(input *ListInferenceRecommendationsJobStepsInput) (req *request.Request, output *ListInferenceRecommendationsJobStepsOutput) { + op := &request.Operation{ + Name: opListInferenceRecommendationsJobSteps, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListInferenceRecommendationsJobStepsInput{} + } + + output = &ListInferenceRecommendationsJobStepsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListInferenceRecommendationsJobSteps API operation for Amazon SageMaker Service. +// +// Returns a list of the subtasks for an Inference Recommender job. +// +// The supported subtasks are benchmarks, which evaluate the performance of +// your model on different instance types. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon SageMaker Service's +// API operation ListInferenceRecommendationsJobSteps for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps +func (c *SageMaker) ListInferenceRecommendationsJobSteps(input *ListInferenceRecommendationsJobStepsInput) (*ListInferenceRecommendationsJobStepsOutput, error) { + req, out := c.ListInferenceRecommendationsJobStepsRequest(input) + return out, req.Send() +} + +// ListInferenceRecommendationsJobStepsWithContext is the same as ListInferenceRecommendationsJobSteps with the addition of +// the ability to pass a context and additional request options. +// +// See ListInferenceRecommendationsJobSteps for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SageMaker) ListInferenceRecommendationsJobStepsWithContext(ctx aws.Context, input *ListInferenceRecommendationsJobStepsInput, opts ...request.Option) (*ListInferenceRecommendationsJobStepsOutput, error) { + req, out := c.ListInferenceRecommendationsJobStepsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListInferenceRecommendationsJobStepsPages iterates over the pages of a ListInferenceRecommendationsJobSteps operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListInferenceRecommendationsJobSteps method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListInferenceRecommendationsJobSteps operation. +// pageNum := 0 +// err := client.ListInferenceRecommendationsJobStepsPages(params, +// func(page *sagemaker.ListInferenceRecommendationsJobStepsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *SageMaker) ListInferenceRecommendationsJobStepsPages(input *ListInferenceRecommendationsJobStepsInput, fn func(*ListInferenceRecommendationsJobStepsOutput, bool) bool) error { + return c.ListInferenceRecommendationsJobStepsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListInferenceRecommendationsJobStepsPagesWithContext same as ListInferenceRecommendationsJobStepsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SageMaker) ListInferenceRecommendationsJobStepsPagesWithContext(ctx aws.Context, input *ListInferenceRecommendationsJobStepsInput, fn func(*ListInferenceRecommendationsJobStepsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListInferenceRecommendationsJobStepsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListInferenceRecommendationsJobStepsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListInferenceRecommendationsJobStepsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListInferenceRecommendationsJobs = "ListInferenceRecommendationsJobs" // ListInferenceRecommendationsJobsRequest generates a "aws/request.Request" representing the @@ -64630,6 +64763,75 @@ func (s *InferenceRecommendationsJob) SetStatus(v string) *InferenceRecommendati return s } +// A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_InferenceRecommendationsJobStep.html) +// API command. +type InferenceRecommendationsJobStep struct { + _ struct{} `type:"structure"` + + // The details for a specific benchmark. + InferenceBenchmark *RecommendationJobInferenceBenchmark `type:"structure"` + + // The name of the Inference Recommender job. + // + // JobName is a required field + JobName *string `min:"1" type:"string" required:"true"` + + // The current status of the benchmark. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"RecommendationJobStatus"` + + // The type of the subtask. + // + // BENCHMARK: Evaluate the performance of your model on different instance types. + // + // StepType is a required field + StepType *string `type:"string" required:"true" enum:"RecommendationStepType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferenceRecommendationsJobStep) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferenceRecommendationsJobStep) GoString() string { + return s.String() +} + +// SetInferenceBenchmark sets the InferenceBenchmark field's value. +func (s *InferenceRecommendationsJobStep) SetInferenceBenchmark(v *RecommendationJobInferenceBenchmark) *InferenceRecommendationsJobStep { + s.InferenceBenchmark = v + return s +} + +// SetJobName sets the JobName field's value. +func (s *InferenceRecommendationsJobStep) SetJobName(v string) *InferenceRecommendationsJobStep { + s.JobName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *InferenceRecommendationsJobStep) SetStatus(v string) *InferenceRecommendationsJobStep { + s.Status = &v + return s +} + +// SetStepType sets the StepType field's value. +func (s *InferenceRecommendationsJobStep) SetStepType(v string) *InferenceRecommendationsJobStep { + s.StepType = &v + return s +} + // Defines how to perform inference generation after a training job is run. type InferenceSpecification struct { _ struct{} `type:"structure"` @@ -70612,6 +70814,139 @@ func (s *ListImagesOutput) SetNextToken(v string) *ListImagesOutput { return s } +type ListInferenceRecommendationsJobStepsInput struct { + _ struct{} `type:"structure"` + + // The name for the Inference Recommender job. + // + // JobName is a required field + JobName *string `min:"1" type:"string" required:"true"` + + // The maximum number of results to return. + MaxResults *int64 `min:"1" type:"integer"` + + // A token that you can specify to return more results from the list. Specify + // this field if you have a token that was returned from a previous request. + NextToken *string `type:"string"` + + // A filter to return benchmarks of a specified status. If this field is left + // empty, then all benchmarks are returned. + Status *string `type:"string" enum:"RecommendationJobStatus"` + + // A filter to return details about the specified type of subtask. + // + // BENCHMARK: Evaluate the performance of your model on different instance types. + StepType *string `type:"string" enum:"RecommendationStepType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListInferenceRecommendationsJobStepsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListInferenceRecommendationsJobStepsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListInferenceRecommendationsJobStepsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListInferenceRecommendationsJobStepsInput"} + if s.JobName == nil { + invalidParams.Add(request.NewErrParamRequired("JobName")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobName sets the JobName field's value. +func (s *ListInferenceRecommendationsJobStepsInput) SetJobName(v string) *ListInferenceRecommendationsJobStepsInput { + s.JobName = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListInferenceRecommendationsJobStepsInput) SetMaxResults(v int64) *ListInferenceRecommendationsJobStepsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListInferenceRecommendationsJobStepsInput) SetNextToken(v string) *ListInferenceRecommendationsJobStepsInput { + s.NextToken = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ListInferenceRecommendationsJobStepsInput) SetStatus(v string) *ListInferenceRecommendationsJobStepsInput { + s.Status = &v + return s +} + +// SetStepType sets the StepType field's value. +func (s *ListInferenceRecommendationsJobStepsInput) SetStepType(v string) *ListInferenceRecommendationsJobStepsInput { + s.StepType = &v + return s +} + +type ListInferenceRecommendationsJobStepsOutput struct { + _ struct{} `type:"structure"` + + // A token that you can specify in your next request to return more results + // from the list. + NextToken *string `type:"string"` + + // A list of all subtask details in Inference Recommender. + Steps []*InferenceRecommendationsJobStep `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListInferenceRecommendationsJobStepsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListInferenceRecommendationsJobStepsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListInferenceRecommendationsJobStepsOutput) SetNextToken(v string) *ListInferenceRecommendationsJobStepsOutput { + s.NextToken = &v + return s +} + +// SetSteps sets the Steps field's value. +func (s *ListInferenceRecommendationsJobStepsOutput) SetSteps(v []*InferenceRecommendationsJobStep) *ListInferenceRecommendationsJobStepsOutput { + s.Steps = v + return s +} + type ListInferenceRecommendationsJobsInput struct { _ struct{} `type:"structure"` @@ -86564,6 +86899,69 @@ func (s *RecommendationJobContainerConfig) SetTask(v string) *RecommendationJobC return s } +// The details for a specific benchmark from an Inference Recommender job. +type RecommendationJobInferenceBenchmark struct { + _ struct{} `type:"structure"` + + // The endpoint configuration made by Inference Recommender during a recommendation + // job. + EndpointConfiguration *EndpointOutputConfiguration `type:"structure"` + + // The reason why a benchmark failed. + FailureReason *string `type:"string"` + + // The metrics of recommendations. + Metrics *RecommendationMetrics `type:"structure"` + + // Defines the model configuration. Includes the specification name and environment + // parameters. + // + // ModelConfiguration is a required field + ModelConfiguration *ModelConfiguration `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationJobInferenceBenchmark) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationJobInferenceBenchmark) GoString() string { + return s.String() +} + +// SetEndpointConfiguration sets the EndpointConfiguration field's value. +func (s *RecommendationJobInferenceBenchmark) SetEndpointConfiguration(v *EndpointOutputConfiguration) *RecommendationJobInferenceBenchmark { + s.EndpointConfiguration = v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *RecommendationJobInferenceBenchmark) SetFailureReason(v string) *RecommendationJobInferenceBenchmark { + s.FailureReason = &v + return s +} + +// SetMetrics sets the Metrics field's value. +func (s *RecommendationJobInferenceBenchmark) SetMetrics(v *RecommendationMetrics) *RecommendationJobInferenceBenchmark { + s.Metrics = v + return s +} + +// SetModelConfiguration sets the ModelConfiguration field's value. +func (s *RecommendationJobInferenceBenchmark) SetModelConfiguration(v *ModelConfiguration) *RecommendationJobInferenceBenchmark { + s.ModelConfiguration = v + return s +} + // The input configuration of the recommendation job. type RecommendationJobInputConfig struct { _ struct{} `type:"structure"` @@ -100523,6 +100921,9 @@ const ( // AutoMLMetricExtendedEnumLogLoss is a AutoMLMetricExtendedEnum enum value AutoMLMetricExtendedEnumLogLoss = "LogLoss" + + // AutoMLMetricExtendedEnumInferenceLatency is a AutoMLMetricExtendedEnum enum value + AutoMLMetricExtendedEnumInferenceLatency = "InferenceLatency" ) // AutoMLMetricExtendedEnum_Values returns all elements of the AutoMLMetricExtendedEnum enum @@ -100542,6 +100943,7 @@ func AutoMLMetricExtendedEnum_Values() []string { AutoMLMetricExtendedEnumRecall, AutoMLMetricExtendedEnumRecallMacro, AutoMLMetricExtendedEnumLogLoss, + AutoMLMetricExtendedEnumInferenceLatency, } } @@ -104371,6 +104773,18 @@ func RecommendationJobType_Values() []string { } } +const ( + // RecommendationStepTypeBenchmark is a RecommendationStepType enum value + RecommendationStepTypeBenchmark = "BENCHMARK" +) + +// RecommendationStepType_Values returns all elements of the RecommendationStepType enum +func RecommendationStepType_Values() []string { + return []string{ + RecommendationStepTypeBenchmark, + } +} + const ( // RecordWrapperNone is a RecordWrapper enum value RecordWrapperNone = "None" diff --git a/service/sagemaker/sagemakeriface/interface.go b/service/sagemaker/sagemakeriface/interface.go index 3d782a7e05..f1dcf65b8a 100644 --- a/service/sagemaker/sagemakeriface/interface.go +++ b/service/sagemaker/sagemakeriface/interface.go @@ -850,6 +850,13 @@ type SageMakerAPI interface { ListImagesPages(*sagemaker.ListImagesInput, func(*sagemaker.ListImagesOutput, bool) bool) error ListImagesPagesWithContext(aws.Context, *sagemaker.ListImagesInput, func(*sagemaker.ListImagesOutput, bool) bool, ...request.Option) error + ListInferenceRecommendationsJobSteps(*sagemaker.ListInferenceRecommendationsJobStepsInput) (*sagemaker.ListInferenceRecommendationsJobStepsOutput, error) + ListInferenceRecommendationsJobStepsWithContext(aws.Context, *sagemaker.ListInferenceRecommendationsJobStepsInput, ...request.Option) (*sagemaker.ListInferenceRecommendationsJobStepsOutput, error) + ListInferenceRecommendationsJobStepsRequest(*sagemaker.ListInferenceRecommendationsJobStepsInput) (*request.Request, *sagemaker.ListInferenceRecommendationsJobStepsOutput) + + ListInferenceRecommendationsJobStepsPages(*sagemaker.ListInferenceRecommendationsJobStepsInput, func(*sagemaker.ListInferenceRecommendationsJobStepsOutput, bool) bool) error + ListInferenceRecommendationsJobStepsPagesWithContext(aws.Context, *sagemaker.ListInferenceRecommendationsJobStepsInput, func(*sagemaker.ListInferenceRecommendationsJobStepsOutput, bool) bool, ...request.Option) error + ListInferenceRecommendationsJobs(*sagemaker.ListInferenceRecommendationsJobsInput) (*sagemaker.ListInferenceRecommendationsJobsOutput, error) ListInferenceRecommendationsJobsWithContext(aws.Context, *sagemaker.ListInferenceRecommendationsJobsInput, ...request.Option) (*sagemaker.ListInferenceRecommendationsJobsOutput, error) ListInferenceRecommendationsJobsRequest(*sagemaker.ListInferenceRecommendationsJobsInput) (*request.Request, *sagemaker.ListInferenceRecommendationsJobsOutput)