You do not have access\n required to perform this action.
", + "smithy.api#documentation": "You do not have access required to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -51,6 +51,9 @@ "input": { "target": "com.amazonaws.acm#AddTagsToCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.acm#InvalidArnException" @@ -75,7 +78,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds one or more tags to an ACM certificate. Tags are labels that you can use to\n identify and organize your Amazon Web Services resources. Each tag consists of a key and an\n optional value. You specify the certificate on input by its Amazon Resource Name\n (ARN). You specify the tag by using a key-value pair.
You can apply a tag to just one certificate if you want to identify a specific\n characteristic of that certificate, or you can apply the same tag to multiple certificates if\n you want to filter for a common relationship among those certificates. Similarly, you can\n apply the same tag to multiple resources if you want to specify a relationship among those\n resources. For example, you can add the same tag to an ACM certificate and an Elastic Load\n Balancing load balancer to indicate that they are both used by the same website. For more\n information, see Tagging ACM\n certificates.
\n\nTo remove one or more tags, use the RemoveTagsFromCertificate action. To\n view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
" + "smithy.api#documentation": "Adds one or more tags to an ACM certificate. Tags are labels that you can use to\n identify and organize your Amazon Web Services resources. Each tag consists of a key and an\n optional value. You specify the certificate on input by its Amazon Resource Name\n (ARN). You specify the tag by using a key-value pair.
You can apply a tag to just one certificate if you want to identify a specific\n characteristic of that certificate, or you can apply the same tag to multiple certificates if\n you want to filter for a common relationship among those certificates. Similarly, you can\n apply the same tag to multiple resources if you want to specify a relationship among those\n resources. For example, you can add the same tag to an ACM certificate and an Elastic Load\n Balancing load balancer to indicate that they are both used by the same website. For more\n information, see Tagging ACM\n certificates.
\nTo remove one or more tags, use the RemoveTagsFromCertificate action. To\n view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
" } }, "com.amazonaws.acm#AddTagsToCertificateRequest": { @@ -84,7 +87,7 @@ "CertificateArn": { "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "String that contains the ARN of the ACM certificate to which the tag is to be applied.\n This must be of the form:
\n\n\n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
For more information about ARNs, see Amazon Resource Names (ARNs).
", + "smithy.api#documentation": "String that contains the ARN of the ACM certificate to which the tag is to be applied.\n This must be of the form:
\n\n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
For more information about ARNs, see Amazon Resource Names (ARNs).
", "smithy.api#required": {} } }, @@ -166,7 +169,7 @@ "SubjectAlternativeNames": { "target": "com.amazonaws.acm#DomainList", "traits": { - "smithy.api#documentation": "One or more domain names (subject alternative names) included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.
" + "smithy.api#documentation": "One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.
" } }, "DomainValidationOptions": { @@ -208,13 +211,13 @@ "ImportedAt": { "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "The date and time at which the certificate was imported. This value exists only when the\n certificate type is IMPORTED.
The date and time when the certificate was imported. This value exists only when the\n certificate type is IMPORTED.
The status of the certificate.
" + "smithy.api#documentation": "The status of the certificate.
\nA certificate enters status PENDING_VALIDATION upon being requested, unless it fails for\n any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes\n repeated attempts to validate a certificate for 72 hours and then times out. If a certificate\n shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and\n try again. If validation succeeds, the certificate enters status ISSUED.
" } }, "RevokedAt": { @@ -262,13 +265,13 @@ "FailureReason": { "target": "com.amazonaws.acm#FailureReason", "traits": { - "smithy.api#documentation": "The reason the certificate request failed. This value exists only when the certificate\n status is FAILED. For more information, see Certificate Request\n Failed in the Amazon Web Services Certificate Manager User Guide.
The reason the certificate request failed. This value exists only when the certificate\n status is FAILED. For more information, see Certificate Request\n Failed in the Certificate Manager User Guide.
The source of the certificate. For certificates provided by ACM, this value is\n AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide\n managed renewal for\n imported certificates. For more information about the differences between certificates that\n you import and those that ACM provides, see Importing Certificates in the\n Amazon Web Services Certificate Manager User Guide.
The source of the certificate. For certificates provided by ACM, this value is\n AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide\n managed renewal for\n imported certificates. For more information about the differences between certificates that\n you import and those that ACM provides, see Importing Certificates in the\n Certificate Manager User Guide.
The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued\n the certificate. This has the following format:
\n\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n
The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the\n certificate. This has the following format:
\n\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n
You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites\n and applications. For more information about using ACM, see the Amazon Web Services Certificate Manager User Guide.
", + "smithy.api#documentation": "You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites\n and applications. For more information about using ACM, see the Certificate Manager User Guide.
", "smithy.api#title": "AWS Certificate Manager" } }, @@ -393,38 +396,50 @@ } }, "com.amazonaws.acm#CertificateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_VALIDATION", - "name": "PENDING_VALIDATION" - }, - { - "value": "ISSUED", - "name": "ISSUED" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" - }, - { - "value": "EXPIRED", - "name": "EXPIRED" - }, - { - "value": "VALIDATION_TIMED_OUT", - "name": "VALIDATION_TIMED_OUT" - }, - { - "value": "REVOKED", - "name": "REVOKED" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "PENDING_VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "ISSUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "VALIDATION_TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.acm#CertificateStatuses": { @@ -439,7 +454,7 @@ "CertificateArn": { "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the certificate. This is of the form:
\n\n\n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
For more information about ARNs, see Amazon Resource Names (ARNs).
" + "smithy.api#documentation": "Amazon Resource Name (ARN) of the certificate. This is of the form:
\n\n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
For more information about ARNs, see Amazon Resource Names (ARNs).
" } }, "DomainName": { @@ -447,6 +462,102 @@ "traits": { "smithy.api#documentation": "Fully qualified domain name (FQDN), such as www.example.com or example.com, for the\n certificate.
" } + }, + "SubjectAlternativeNameSummaries": { + "target": "com.amazonaws.acm#DomainList", + "traits": { + "smithy.api#documentation": "One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.
\nWhen called by ListCertificates, this parameter will only return the first 100 subject alternative\n names included in the certificate. To display the full list of subject alternative names, use\n DescribeCertificate.
" + } + }, + "HasAdditionalSubjectAlternativeNames": { + "target": "com.amazonaws.acm#NullableBoolean", + "traits": { + "smithy.api#documentation": "When called by ListCertificates, indicates whether the full list of subject alternative names has\n been included in the response. If false, the response includes all of the subject alternative\n names included in the certificate. If true, the response only includes the first 100 subject\n alternative names included in the certificate. To display the full list of subject alternative\n names, use DescribeCertificate.
" + } + }, + "Status": { + "target": "com.amazonaws.acm#CertificateStatus", + "traits": { + "smithy.api#documentation": "The status of the certificate.
\nA certificate enters status PENDING_VALIDATION upon being requested, unless it fails for\n any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes\n repeated attempts to validate a certificate for 72 hours and then times out. If a certificate\n shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and\n try again. If validation succeeds, the certificate enters status ISSUED.
" + } + }, + "Type": { + "target": "com.amazonaws.acm#CertificateType", + "traits": { + "smithy.api#documentation": "The source of the certificate. For certificates provided by ACM, this value is\n AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide\n managed renewal for\n imported certificates. For more information about the differences between certificates that\n you import and those that ACM provides, see Importing Certificates in the\n Certificate Manager User Guide.
The algorithm that was used to generate the public-private key pair.
" + } + }, + "KeyUsages": { + "target": "com.amazonaws.acm#KeyUsageNames", + "traits": { + "smithy.api#documentation": "A list of Key Usage X.509 v3 extension objects. Each object is a string value that\n identifies the purpose of the public key contained in the certificate. Possible extension\n values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
" + } + }, + "ExtendedKeyUsages": { + "target": "com.amazonaws.acm#ExtendedKeyUsageNames", + "traits": { + "smithy.api#documentation": "Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a\n purpose for which the certificate public key can be used and consists of a name and an object\n identifier (OID).
" + } + }, + "InUse": { + "target": "com.amazonaws.acm#NullableBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the certificate is currently in use by any Amazon Web Services resources.
" + } + }, + "Exported": { + "target": "com.amazonaws.acm#NullableBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the certificate has been exported. This value exists only when the\n certificate type is PRIVATE.
Specifies whether the certificate is eligible for renewal. At this time, only exported\n private certificates can be renewed with the RenewCertificate\n command.
" + } + }, + "NotBefore": { + "target": "com.amazonaws.acm#TStamp", + "traits": { + "smithy.api#documentation": "The time before which the certificate is not valid.
" + } + }, + "NotAfter": { + "target": "com.amazonaws.acm#TStamp", + "traits": { + "smithy.api#documentation": "The time after which the certificate is not valid.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.acm#TStamp", + "traits": { + "smithy.api#documentation": "The time at which the certificate was requested.
" + } + }, + "IssuedAt": { + "target": "com.amazonaws.acm#TStamp", + "traits": { + "smithy.api#documentation": "The time at which the certificate was issued. This value exists only when the certificate\n type is AMAZON_ISSUED.
The date and time when the certificate was imported. This value exists only when the\n certificate type is IMPORTED.
The time at which the certificate was revoked. This value exists only when the certificate\n status is REVOKED.
You are trying to\n update a resource or configuration that is already being created or updated. Wait for the\n previous operation to finish and try again.
", + "smithy.api#documentation": "You are trying to update a resource or configuration that is already being created or\n updated. Wait for the previous operation to finish and try again.
", "smithy.api#error": "client" } }, @@ -510,6 +627,9 @@ "input": { "target": "com.amazonaws.acm#DeleteCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.acm#InvalidArnException" @@ -554,7 +674,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns detailed metadata about the specified ACM certificate.
", + "smithy.api#documentation": "Returns detailed metadata about the specified ACM certificate.
\nIf you have just created a certificate using the RequestCertificate action,\n there is a delay of several seconds before you can retrieve information about it.
The validation status of the domain name. This can be one of the following values:
\n\n\n PENDING_VALIDATION\n
\n SUCCESS
\n FAILED
The validation status of the domain name. This can be one of the following values:
\n\n PENDING_VALIDATION\n
\n SUCCESS
\n FAILED
Object containing\n expiration events options associated with an Amazon Web Services account.
" + "smithy.api#documentation": "Object containing expiration events options associated with an Amazon Web Services account.
" } }, "com.amazonaws.acm#ExportCertificate": { @@ -805,7 +929,7 @@ "Passphrase": { "target": "com.amazonaws.acm#PassphraseBlob", "traits": { - "smithy.api#documentation": "Passphrase to associate with the encrypted exported private key. If you want to later\n decrypt the private key, you must have the passphrase. You can use the following OpenSSL\n command to decrypt a private key:
\n\n openssl rsa -in encrypted_key.pem -out decrypted_key.pem\n
Passphrase to associate with the encrypted exported private key.
\nWhen creating your passphrase, you can use any ASCII character except #, $, or %.
\nIf you want to later decrypt the private key, you must have the passphrase. You can use\n the following OpenSSL command to decrypt a private key. After entering the command, you are\n prompted for the passphrase.
\n\n openssl rsa -in encrypted_key.pem -out decrypted_key.pem\n
An object identifier (OID) for the extension value. OIDs are strings of numbers separated\n by periods. The following OIDs are defined in RFC 3280 and RFC 5280.
\n\n\n 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)\n
\n 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)\n
\n 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)\n
\n 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)\n
\n 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)\n
\n 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)\n
\n 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)\n
\n 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)\n
\n 1.3.6.1.5.5.7.3.7 (IPSEC_USER)\n
An object identifier (OID) for the extension value. OIDs are strings of numbers separated\n by periods. The following OIDs are defined in RFC 3280 and RFC 5280.
\n\n 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)\n
\n 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)\n
\n 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)\n
\n 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)\n
\n 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)\n
\n 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)\n
\n 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)\n
\n 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)\n
\n 1.3.6.1.5.5.7.3.7 (IPSEC_USER)\n
Specify one or more algorithms that can be used to generate key pairs.
\nDefault filtering returns only RSA_1024 and RSA_2048\n certificates that have at least one domain. To return other certificate types, provide the\n desired type signatures in a comma-separated list. For example, \"keyTypes\":\n [\"RSA_2048,RSA_4096\"] returns both RSA_2048 and RSA_4096\n certificates.
Specify one or more algorithms that can be used to generate key pairs.
\nDefault filtering returns only RSA_1024 and RSA_2048\n certificates that have at least one domain. To return other certificate types, provide the\n desired type signatures in a comma-separated list. For example, \"keyTypes\":\n [\"RSA_2048\",\"RSA_4096\"] returns both RSA_2048 and RSA_4096\n certificates.
Returns the account\n configuration options associated with an Amazon Web Services account.
" + "smithy.api#documentation": "Returns the account configuration options associated with an Amazon Web Services account.
" } }, "com.amazonaws.acm#GetAccountConfigurationResponse": { @@ -1045,7 +1232,7 @@ "ExpiryEvents": { "target": "com.amazonaws.acm#ExpiryEventsConfiguration", "traits": { - "smithy.api#documentation": "Expiration events\n configuration options associated with the Amazon Web Services account.
" + "smithy.api#documentation": "Expiration events configuration options associated with the Amazon Web Services account.
" } } } @@ -1144,7 +1331,7 @@ } ], "traits": { - "smithy.api#documentation": "Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with\n ACM. Note that integrated\n services allow only certificate types and keys they support to be associated with\n their resources. Further, their support differs depending on whether the certificate is\n imported into IAM or into ACM. For more information, see the documentation for each\n service. For more information about importing certificates into ACM, see Importing\n Certificates in the Amazon Web Services Certificate Manager User Guide.
\n\nACM does not provide managed renewal for certificates that you import.
\nNote the following guidelines when importing third party certificates:
\n\n\nYou must enter the private key that matches the certificate you are importing.
\nThe private key must be unencrypted. You cannot import a private key that is protected\n by a password or a passphrase.
\nThe private key must be no larger than 5 KB (5,120 bytes).
\nIf the certificate you are importing is not self-signed, you must enter its\n certificate chain.
\nIf a certificate chain is included, the issuer must be the subject of one of the\n certificates in the chain.
\nThe certificate, private key, and certificate chain must be PEM-encoded.
\nThe current time must be between the Not Before and Not\n After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
\nTo import a new certificate, omit the CertificateArn argument. Include\n this argument only when you want to replace a previously imported certificate.
When you import a certificate by using the CLI, you must specify the certificate, the\n certificate chain, and the private key by their file names preceded by\n fileb://. For example, you can specify a certificate saved in the\n C:\\temp folder as fileb://C:\\temp\\certificate_to_import.pem.\n If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.\n
When you import a certificate by using an SDK, you must specify the certificate, the\n certificate chain, and the private key files in the manner required by the programming\n language you're using.
\nThe cryptographic algorithm of an imported certificate must match the algorithm of the\n signing CA. For example, if the signing CA key type is RSA, then the certificate key type\n must also be RSA.
\nThis operation returns the Amazon\n Resource Name (ARN) of the imported certificate.
" + "smithy.api#documentation": "Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with\n ACM. Note that integrated\n services allow only certificate types and keys they support to be associated with\n their resources. Further, their support differs depending on whether the certificate is\n imported into IAM or into ACM. For more information, see the documentation for each\n service. For more information about importing certificates into ACM, see Importing\n Certificates in the Certificate Manager User Guide.
\nACM does not provide managed renewal for certificates that you import.
\nNote the following guidelines when importing third party certificates:
\nYou must enter the private key that matches the certificate you are importing.
\nThe private key must be unencrypted. You cannot import a private key that is protected\n by a password or a passphrase.
\nThe private key must be no larger than 5 KB (5,120 bytes).
\nIf the certificate you are importing is not self-signed, you must enter its\n certificate chain.
\nIf a certificate chain is included, the issuer must be the subject of one of the\n certificates in the chain.
\nThe certificate, private key, and certificate chain must be PEM-encoded.
\nThe current time must be between the Not Before and Not\n After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
\nTo import a new certificate, omit the CertificateArn argument. Include\n this argument only when you want to replace a previously imported certificate.
When you import a certificate by using the CLI, you must specify the certificate, the\n certificate chain, and the private key by their file names preceded by\n fileb://. For example, you can specify a certificate saved in the\n C:\\temp folder as fileb://C:\\temp\\certificate_to_import.pem.\n If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.\n
When you import a certificate by using an SDK, you must specify the certificate, the\n certificate chain, and the private key files in the manner required by the programming\n language you're using.
\nThe cryptographic algorithm of an imported certificate must match the algorithm of the\n signing CA. For example, if the signing CA key type is RSA, then the certificate key type\n must also be RSA.
\nThis operation returns the Amazon\n Resource Name (ARN) of the imported certificate.
" } }, "com.amazonaws.acm#ImportCertificateRequest": { @@ -1274,38 +1461,50 @@ } }, "com.amazonaws.acm#KeyAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RSA_1024", - "name": "RSA_1024" - }, - { - "value": "RSA_2048", - "name": "RSA_2048" - }, - { - "value": "RSA_3072", - "name": "RSA_3072" - }, - { - "value": "RSA_4096", - "name": "RSA_4096" - }, - { - "value": "EC_prime256v1", - "name": "EC_prime256v1" - }, - { - "value": "EC_secp384r1", - "name": "EC_secp384r1" - }, - { - "value": "EC_secp521r1", - "name": "EC_secp521r1" - } - ] + "type": "enum", + "members": { + "RSA_1024": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSA_1024" + } + }, + "RSA_2048": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSA_2048" + } + }, + "RSA_3072": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSA_3072" + } + }, + "RSA_4096": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSA_4096" + } + }, + "EC_prime256v1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC_prime256v1" + } + }, + "EC_secp384r1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC_secp384r1" + } + }, + "EC_secp521r1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC_secp521r1" + } + } } }, "com.amazonaws.acm#KeyAlgorithmList": { @@ -1341,54 +1540,80 @@ } }, "com.amazonaws.acm#KeyUsageName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DIGITAL_SIGNATURE", - "name": "DIGITAL_SIGNATURE" - }, - { - "value": "NON_REPUDIATION", - "name": "NON_REPUDATION" - }, - { - "value": "KEY_ENCIPHERMENT", - "name": "KEY_ENCIPHERMENT" - }, - { - "value": "DATA_ENCIPHERMENT", - "name": "DATA_ENCIPHERMENT" - }, - { - "value": "KEY_AGREEMENT", - "name": "KEY_AGREEMENT" - }, - { - "value": "CERTIFICATE_SIGNING", - "name": "CERTIFICATE_SIGNING" - }, - { - "value": "CRL_SIGNING", - "name": "CRL_SIGNING" - }, - { - "value": "ENCIPHER_ONLY", - "name": "ENCHIPER_ONLY" - }, - { - "value": "DECIPHER_ONLY", - "name": "DECIPHER_ONLY" - }, - { - "value": "ANY", - "name": "ANY" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" - } - ] + "type": "enum", + "members": { + "DIGITAL_SIGNATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIGITAL_SIGNATURE" + } + }, + "NON_REPUDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_REPUDIATION" + } + }, + "KEY_ENCIPHERMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_ENCIPHERMENT" + } + }, + "DATA_ENCIPHERMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_ENCIPHERMENT" + } + }, + "KEY_AGREEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_AGREEMENT" + } + }, + "CERTIFICATE_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_SIGNING" + } + }, + "CRL_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRL_SIGNING" + } + }, + "ENCHIPER_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCIPHER_ONLY" + } + }, + "DECIPHER_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIPHER_ONLY" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.acm#KeyUsageNames": { + "type": "list", + "member": { + "target": "com.amazonaws.acm#KeyUsageName" } }, "com.amazonaws.acm#LimitExceededException": { @@ -1452,6 +1677,18 @@ "traits": { "smithy.api#documentation": "Use this parameter when paginating results to specify the maximum number of items to\n return in the response. If additional items exist beyond the number you specify, the\n NextToken element is sent in the response. Use this NextToken\n value in a subsequent request to retrieve additional items.
Specifies the field to sort results by. If you specify SortBy, you must also\n specify SortOrder.
Specifies the order of sorted results. If you specify SortOrder, you must\n also specify SortBy.
Adds or modifies\n account-level configurations in ACM.\n
\nThe\n supported configuration option is DaysBeforeExpiry. This option specifies the\n number of days prior to certificate expiration when ACM starts generating\n EventBridge events. ACM sends one event per day per certificate until the\n certificate expires. By default, accounts receive events starting 45 days before certificate\n expiration.
Adds or modifies account-level configurations in ACM.
\nThe supported configuration option is DaysBeforeExpiry. This option specifies\n the number of days prior to certificate expiration when ACM starts generating\n EventBridge events. ACM sends one event per day per certificate until the\n certificate expires. By default, accounts receive events starting 45 days before certificate\n expiration.
Specifies expiration\n events associated with an account.
" + "smithy.api#documentation": "Specifies expiration events associated with an account.
" } }, "IdempotencyToken": { "target": "com.amazonaws.acm#IdempotencyToken", "traits": { - "smithy.api#documentation": "Customer-chosen string\n used to distinguish between calls to PutAccountConfiguration. Idempotency tokens\n time out after one hour. If you call PutAccountConfiguration multiple times with\n the same unexpired idempotency token, ACM treats it as the same request and returns the\n original result. If you change the idempotency token for each call, ACM treats each call as\n a new request.
Customer-chosen string used to distinguish between calls to\n PutAccountConfiguration. Idempotency tokens time out after one hour. If you\n call PutAccountConfiguration multiple times with the same unexpired idempotency\n token, ACM treats it as the same request and returns the original result. If you change the\n idempotency token for each call, ACM treats each call as a new request.
Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If\n you do not specify the value portion of the tag when calling this function, the tag will be\n removed regardless of value. If you specify a value, the tag is removed only if it is\n associated with the specified value.
\n\nTo add tags to a certificate, use the AddTagsToCertificate action. To\n view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
" + "smithy.api#documentation": "Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If\n you do not specify the value portion of the tag when calling this function, the tag will be\n removed regardless of value. If you specify a value, the tag is removed only if it is\n associated with the specified value.
\nTo add tags to a certificate, use the AddTagsToCertificate action. To\n view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
" } }, "com.amazonaws.acm#RemoveTagsFromCertificateRequest": { @@ -1662,7 +1906,7 @@ "CertificateArn": { "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "String that contains the ARN of the ACM Certificate with one or more tags that you want\n to remove. This must be of the form:
\n\n\n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
For more information about ARNs, see Amazon Resource Names (ARNs).
", + "smithy.api#documentation": "String that contains the ARN of the ACM Certificate with one or more tags that you want\n to remove. This must be of the form:
\n\n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
For more information about ARNs, see Amazon Resource Names (ARNs).
", "smithy.api#required": {} } }, @@ -1680,6 +1924,9 @@ "input": { "target": "com.amazonaws.acm#RenewCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.acm#InvalidArnException" @@ -1689,7 +1936,7 @@ } ], "traits": { - "smithy.api#documentation": "Renews an eligible ACM certificate. At this time, only exported private certificates can\n be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must\n first grant the ACM\n service principal permission to do so. For more information, see Testing Managed Renewal\n in the ACM User Guide.
" + "smithy.api#documentation": "Renews an eligible ACM certificate. At this time, only exported private certificates can\n be renewed with this operation. In order to renew your ACM Private CA certificates with ACM, you\n must first grant the ACM\n service principal permission to do so. For more information, see Testing Managed Renewal\n in the ACM User Guide.
" } }, "com.amazonaws.acm#RenewCertificateRequest": { @@ -1705,41 +1952,49 @@ } }, "com.amazonaws.acm#RenewalEligibility": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ELIGIBLE", - "name": "ELIGIBLE" - }, - { - "value": "INELIGIBLE", - "name": "INELIGIBLE" + "type": "enum", + "members": { + "ELIGIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELIGIBLE" + } + }, + "INELIGIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INELIGIBLE" } - ] + } } }, "com.amazonaws.acm#RenewalStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_AUTO_RENEWAL", - "name": "PENDING_AUTO_RENEWAL" - }, - { - "value": "PENDING_VALIDATION", - "name": "PENDING_VALIDATION" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "PENDING_AUTO_RENEWAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" + } + }, + "PENDING_VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.acm#RenewalSummary": { @@ -1809,7 +2064,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM\n certificate, you must specify a fully qualified domain name (FQDN) in the\n DomainName parameter. You can also specify additional FQDNs in the\n SubjectAlternativeNames parameter.
If you are requesting a private certificate, domain validation is not required. If you are\n requesting a public certificate, each domain name that you specify must be validated to verify\n that you own or control the domain. You can use DNS validation or email validation.\n We recommend that you use DNS validation. ACM issues public certificates after receiving\n approval from the domain owner.
\n \nACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2RFC 6125 specification of the\n certificate validation process. first checks for a subject alternative name, and, if it\n finds one, ignores the common name (CN)
\nRequests an ACM certificate for use with other Amazon Web Services services. To request an ACM\n certificate, you must specify a fully qualified domain name (FQDN) in the\n DomainName parameter. You can also specify additional FQDNs in the\n SubjectAlternativeNames parameter.
If you are requesting a private certificate, domain validation is not required. If you are\n requesting a public certificate, each domain name that you specify must be validated to verify\n that you own or control the domain. You can use DNS validation or email validation.\n We recommend that you use DNS validation. ACM issues public certificates after receiving\n approval from the domain owner.
\nACM behavior differs from the RFC 6125\n specification of the certificate validation process. ACM first checks for a Subject\n Alternative Name, and, if it finds one, ignores the common name (CN).
\nAfter successful completion of the RequestCertificate action, there is a\n delay of several seconds before you can retrieve information about the new certificate.
Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with\n an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects\n several sites in the same domain. For example, *.example.com protects www.example.com,\n site.example.com, and images.example.com.
\n\nThe first domain name you enter cannot exceed 64 octets, including periods. Each\n subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
", + "smithy.api#documentation": "Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with\n an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects\n several sites in the same domain. For example, *.example.com protects www.example.com,\n site.example.com, and images.example.com.
\nIn compliance with RFC\n 5280, the length of the domain name (technically, the Common Name) that you provide\n cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative\n Name field, which supports names up to 253 octets in length.
", "smithy.api#required": {} } }, @@ -1831,7 +2086,7 @@ "SubjectAlternativeNames": { "target": "com.amazonaws.acm#DomainList", "traits": { - "smithy.api#documentation": "Additional FQDNs to be included in the Subject Alternative Name extension of the ACM\n certificate. For example, add the name www.example.net to a certificate for which the\n DomainName field is www.example.com if users can reach your site by using\n either name. The maximum number of domain names that you can add to an ACM certificate is\n 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must\n request a quota increase. For more information, see Quotas.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple\n labels separated by periods. No label can be longer than 63 octets. Consider the following\n examples:
\n\n\n (63 octets).(63 octets).(63 octets).(61 octets) is legal because the\n total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
\n (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the\n total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63\n octets.
\n (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the\n total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM\n certificate. For example, add the name www.example.net to a certificate for which the\n DomainName field is www.example.com if users can reach your site by using\n either name. The maximum number of domain names that you can add to an ACM certificate is\n 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must\n request a quota increase. For more information, see Quotas.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple\n labels separated by periods. No label can be longer than 63 octets. Consider the following\n examples:
\n\n (63 octets).(63 octets).(63 octets).(61 octets) is legal because the\n total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
\n (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the\n total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63\n octets.
\n (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the\n total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used\n to issue the certificate. If you do not provide an ARN and you are trying to request a private\n certificate, ACM will attempt to issue a public certificate. For more information about\n private CAs, see the Amazon Web Services Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
\n\n\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used\n to issue the certificate. If you do not provide an ARN and you are trying to request a private\n certificate, ACM will attempt to issue a public certificate. For more information about\n private CAs, see the Certificate Manager Private Certificate Authority user guide. The ARN must have the following form:
\n\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n
String that contains the ARN of the requested certificate. The certificate ARN is\n generated and returned by the RequestCertificate action as soon as the\n request is made. By default, using this parameter causes email to be sent to all top-level\n domains you specified in the certificate request. The ARN must be of the form:
\n\n\n arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
String that contains the ARN of the requested certificate. The certificate ARN is\n generated and returned by the RequestCertificate action as soon as the\n request is made. By default, using this parameter causes email to be sent to all top-level\n domains you specified in the certificate request. The ARN must be of the form:
\n\n arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012\n
Contains a DNS record value that you can use to validate ownership or control\n of a domain. This is used by the DescribeCertificate action.
" + "smithy.api#documentation": "Contains a DNS record value that you can use to validate ownership or control of a domain.\n This is used by the DescribeCertificate action.
" } }, "com.amazonaws.acm#RevocationReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNSPECIFIED", - "name": "UNSPECIFIED" - }, - { - "value": "KEY_COMPROMISE", - "name": "KEY_COMPROMISE" - }, - { - "value": "CA_COMPROMISE", - "name": "CA_COMPROMISE" - }, - { - "value": "AFFILIATION_CHANGED", - "name": "AFFILIATION_CHANGED" - }, - { - "value": "SUPERCEDED", - "name": "SUPERCEDED" - }, - { - "value": "CESSATION_OF_OPERATION", - "name": "CESSATION_OF_OPERATION" - }, - { - "value": "CERTIFICATE_HOLD", - "name": "CERTIFICATE_HOLD" - }, - { - "value": "REMOVE_FROM_CRL", - "name": "REMOVE_FROM_CRL" - }, - { - "value": "PRIVILEGE_WITHDRAWN", - "name": "PRIVILEGE_WITHDRAWN" - }, - { - "value": "A_A_COMPROMISE", - "name": "A_A_COMPROMISE" - } - ] + "type": "enum", + "members": { + "UNSPECIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + }, + "KEY_COMPROMISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_COMPROMISE" + } + }, + "CA_COMPROMISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_COMPROMISE" + } + }, + "AFFILIATION_CHANGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFFILIATION_CHANGED" + } + }, + "SUPERCEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERCEDED" + } + }, + "CESSATION_OF_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CESSATION_OF_OPERATION" + } + }, + "CERTIFICATE_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_HOLD" + } + }, + "REMOVE_FROM_CRL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_FROM_CRL" + } + }, + "PRIVILEGE_WITHDRAWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" + } + }, + "A_A_COMPROMISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A_A_COMPROMISE" + } + } } }, "com.amazonaws.acm#ServiceErrorMessage": { "type": "string" }, + "com.amazonaws.acm#SortBy": { + "type": "enum", + "members": { + "CREATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED_AT" + } + } + } + }, + "com.amazonaws.acm#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, "com.amazonaws.acm#String": { "type": "string" }, @@ -2124,7 +2428,7 @@ "code": "Throttling", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request was denied\n because it exceeded a quota.
", + "smithy.api#documentation": "The request was denied because it exceeded a quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2146,6 +2450,9 @@ "input": { "target": "com.amazonaws.acm#UpdateCertificateOptionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.acm#InvalidArnException" @@ -2201,7 +2508,7 @@ "code": "ValidationError", "httpResponseCode": 400 }, - "smithy.api#documentation": "The supplied input\n failed to satisfy constraints of an Amazon Web Services service.
", + "smithy.api#documentation": "The supplied input failed to satisfy constraints of an Amazon Web Services service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2210,18 +2517,20 @@ "type": "string" }, "com.amazonaws.acm#ValidationMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "DNS", - "name": "DNS" - } - ] + "type": "enum", + "members": { + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "DNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS" + } + } } } } diff --git a/codegen/sdk/aws-models/apprunner.json b/codegen/sdk/aws-models/apprunner.json index d8664c2c476..462defb45cd 100644 --- a/codegen/sdk/aws-models/apprunner.json +++ b/codegen/sdk/aws-models/apprunner.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -32,7 +32,6 @@ "com.amazonaws.apprunner#ASConfigMaxConcurrency": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 200 @@ -42,7 +41,6 @@ "com.amazonaws.apprunner#ASConfigMaxSize": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 25 @@ -52,7 +50,6 @@ "com.amazonaws.apprunner#ASConfigMinSize": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 25 @@ -61,24 +58,6 @@ }, "com.amazonaws.apprunner#AppRunner": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "AppRunner", - "arnNamespace": "apprunner", - "cloudFormationName": "AppRunner", - "cloudTrailEventSource": "apprunner.amazonaws.com", - "endpointPrefix": "apprunner" - }, - "aws.auth#sigv4": { - "name": "apprunner" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code\n to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to\n provision and configure Amazon Web Services resources.
\nApp Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations,\n high performance, scalability, and security.
\nFor more information about App Runner, see the App Runner Developer Guide.\n For release information, see the App Runner Release Notes.
\n\n To install the Software Development Kits (SDKs), Integrated\n Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for\n Amazon Web Services.
\n\n Endpoints\n
\nFor a list of Region-specific endpoints that App Runner supports, see App Runner\n endpoints and quotas in the Amazon Web Services General Reference.
", - "smithy.api#title": "AWS App Runner", - "smithy.api#xmlNamespace": { - "uri": "http://apprunner.amazonaws.com/doc/2020-05-15/" - } - }, "version": "2020-05-15", "operations": [ { @@ -171,7 +150,25 @@ { "target": "com.amazonaws.apprunner#UpdateService" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "AppRunner", + "arnNamespace": "apprunner", + "cloudFormationName": "AppRunner", + "cloudTrailEventSource": "apprunner.amazonaws.com", + "endpointPrefix": "apprunner" + }, + "aws.auth#sigv4": { + "name": "apprunner" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code\n to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to\n provision and configure Amazon Web Services resources.
\nApp Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations,\n high performance, scalability, and security.
\nFor more information about App Runner, see the App Runner Developer Guide.\n For release information, see the App Runner Release Notes.
\n\n To install the Software Development Kits (SDKs), Integrated\n Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for\n Amazon Web Services.
\n\n Endpoints\n
\nFor a list of Region-specific endpoints that App Runner supports, see App Runner\n endpoints and quotas in the Amazon Web Services General Reference.
", + "smithy.api#title": "AWS App Runner", + "smithy.api#xmlNamespace": { + "uri": "http://apprunner.amazonaws.com/doc/2020-05-15/" + } + } }, "com.amazonaws.apprunner#AppRunnerResourceArn": { "type": "string", @@ -295,12 +292,14 @@ "AutoScalingConfigurationRevision": { "target": "com.amazonaws.apprunner#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same\n AutoScalingConfigurationName.
It's set to true for the configuration with the highest Revision among all configurations that share the same\n AutoScalingConfigurationName. It's set to false otherwise.
The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service\n up.
" } }, "MinSize": { "target": "com.amazonaws.apprunner#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some\n of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be\n quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
" } }, "MaxSize": { "target": "com.amazonaws.apprunner#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.
The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") with the same\n AutoScalingConfigurationName.
Set to true to list only the latest revision for each requested configuration name.
Set to false to list all revisions for each requested configuration name.
Default: true\n
Set to true to list only the latest revision for each requested configuration name.
Set to false to list all revisions for each requested configuration name.
Default: true\n
The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the\n same ObservabilityConfigurationName.
It's set to true for the configuration with the highest Revision among all configurations that share the same\n ObservabilityConfigurationName. It's set to false otherwise.
The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the\n same ObservabilityConfigurationName.
When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is\n specified.
The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same\n Name.
At this time, App Runner supports only one revision per name.
\nBackup gateway connects Backup to your hypervisor, so you can\n create, store, and restore backups of your virtual machines (VMs) anywhere, whether\n on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
\nAdd on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
\nUse Backup to assign virtual or on-premises resources to a backup plan, or run\n on-demand backups. Once you have backed up your resources, you can view them and restore them\n like any resource supported by Backup.
\nTo download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - }, - "smithy.api#title": "AWS Backup Gateway" - }, "version": "2021-01-01", "operations": [ { "target": "com.amazonaws.backupgateway#ListTagsForResource" }, - { - "target": "com.amazonaws.backupgateway#ListVirtualMachines" - }, { "target": "com.amazonaws.backupgateway#TagResource" }, @@ -127,8 +104,36 @@ }, { "target": "com.amazonaws.backupgateway#HypervisorResource" + }, + { + "target": "com.amazonaws.backupgateway#VirtualMachineResource" } - ] + ], + "errors": [ + { + "target": "com.amazonaws.backupgateway#ThrottlingException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Backup Gateway", + "arnNamespace": "backup-gateway", + "cloudFormationName": "BackupGateway", + "cloudTrailEventSource": "backup-gateway.amazonaws.com", + "endpointPrefix": "backup-gateway" + }, + "aws.auth#sigv4": { + "name": "backup-gateway" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Backup gateway connects Backup to your hypervisor, so you can\n create, store, and restore backups of your virtual machines (VMs) anywhere, whether\n on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
\nAdd on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
\nUse Backup to assign virtual or on-premises resources to a backup plan, or run\n on-demand backups. Once you have backed up your resources, you can view them and restore them\n like any resource supported by Backup.
\nTo download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#title": "AWS Backup Gateway" + } }, "com.amazonaws.backupgateway#ConflictException": { "type": "structure", @@ -216,7 +221,6 @@ "com.amazonaws.backupgateway#DayOfMonth": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 31 @@ -226,7 +230,6 @@ "com.amazonaws.backupgateway#DayOfWeek": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 6 @@ -460,6 +463,12 @@ "smithy.api#documentation": "Details showing the last time Backup gateway communicated\n with the cloud, in Unix format and UTC time.
" } }, + "MaintenanceStartTime": { + "target": "com.amazonaws.backupgateway#MaintenanceStartTime", + "traits": { + "smithy.api#documentation": "Returns your gateway's weekly maintenance start time including the day and time of the week. \n Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
" + } + }, "NextUpdateAvailabilityTime": { "target": "com.amazonaws.backupgateway#Time", "traits": { @@ -586,6 +595,53 @@ } } }, + "com.amazonaws.backupgateway#GetVirtualMachine": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#GetVirtualMachineInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#GetVirtualMachineOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#GetVirtualMachineInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual machine.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#GetVirtualMachineOutput": { + "type": "structure", + "members": { + "VirtualMachine": { + "target": "com.amazonaws.backupgateway#VirtualMachineDetails", + "traits": { + "smithy.api#documentation": "This object contains the basic attributes of VirtualMachine contained by the output of \n GetVirtualMachine\n
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
" + } + }, "MaxResults": { "target": "com.amazonaws.backupgateway#MaxResults", "traits": { @@ -1039,10 +1100,43 @@ } } }, + "com.amazonaws.backupgateway#MaintenanceStartTime": { + "type": "structure", + "members": { + "DayOfMonth": { + "target": "com.amazonaws.backupgateway#DayOfMonth", + "traits": { + "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal number from \n 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
" + } + }, + "DayOfWeek": { + "target": "com.amazonaws.backupgateway#DayOfWeek", + "traits": { + "smithy.api#documentation": "An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday \n and 6 represents Saturday. The day of week is in the time zone of the gateway.
" + } + }, + "HourOfDay": { + "target": "com.amazonaws.backupgateway#HourOfDay", + "traits": { + "smithy.api#documentation": "The hour component of the maintenance start time represented as hh, \n where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
", + "smithy.api#required": {} + } + }, + "MinuteOfHour": { + "target": "com.amazonaws.backupgateway#MinuteOfHour", + "traits": { + "smithy.api#documentation": "The minute component of the maintenance start time represented as mm, where \n mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This is your gateway's weekly maintenance start time including the day and time of the week. \n Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
" + } + }, "com.amazonaws.backupgateway#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -1051,7 +1145,6 @@ "com.amazonaws.backupgateway#MinuteOfHour": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 59 @@ -1381,6 +1474,26 @@ "type": "structure", "members": {} }, + "com.amazonaws.backupgateway#ThrottlingException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "Error: TPS has been limited to protect against intentional or unintentional \n high request volumes.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.backupgateway#string" + } + }, + "traits": { + "smithy.api#documentation": "TPS has been limited to protect against intentional or unintentional \n high request volumes.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.backupgateway#Time": { "type": "timestamp" }, @@ -1685,6 +1798,69 @@ "smithy.api#documentation": "A virtual machine that is on a hypervisor.
" } }, + "com.amazonaws.backupgateway#VirtualMachineDetails": { + "type": "structure", + "members": { + "HostName": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The host name of the virtual machine.
" + } + }, + "HypervisorId": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "The ID of the virtual machine's hypervisor.
" + } + }, + "Name": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The name of the virtual machine.
" + } + }, + "Path": { + "target": "com.amazonaws.backupgateway#Path", + "traits": { + "smithy.api#documentation": "The path of the virtual machine.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual machine. For example, \n arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.
The most recent date a virtual machine was backed up, in Unix format and UTC time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).
Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountHasOngoingImport", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "\n This exception is thrown when you start a new import and a \n previous import is still in progress.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#AddTags": { "type": "operation", "input": { @@ -199,10 +219,7 @@ } }, "com.amazonaws.cloudtrail#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.cloudtrail#ByteBuffer": { "type": "blob" @@ -435,24 +452,6 @@ }, "com.amazonaws.cloudtrail#CloudTrail_20131101": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "CloudTrail", - "arnNamespace": "cloudtrail", - "cloudFormationName": "CloudTrail", - "cloudTrailEventSource": "cloudtrail.amazonaws.com", - "endpointPrefix": "cloudtrail" - }, - "aws.auth#sigv4": { - "name": "cloudtrail" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
\n \nAs an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see Tools to Build on Amazon Web Services.
\nSee the CloudTrail User \n Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
", - "smithy.api#title": "AWS CloudTrail", - "smithy.api#xmlNamespace": { - "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" - } - }, "version": "2013-11-01", "operations": [ { @@ -488,6 +487,9 @@ { "target": "com.amazonaws.cloudtrail#GetEventSelectors" }, + { + "target": "com.amazonaws.cloudtrail#GetImport" + }, { "target": "com.amazonaws.cloudtrail#GetInsightSelectors" }, @@ -506,6 +508,12 @@ { "target": "com.amazonaws.cloudtrail#ListEventDataStores" }, + { + "target": "com.amazonaws.cloudtrail#ListImportFailures" + }, + { + "target": "com.amazonaws.cloudtrail#ListImports" + }, { "target": "com.amazonaws.cloudtrail#ListPublicKeys" }, @@ -533,12 +541,18 @@ { "target": "com.amazonaws.cloudtrail#RestoreEventDataStore" }, + { + "target": "com.amazonaws.cloudtrail#StartImport" + }, { "target": "com.amazonaws.cloudtrail#StartLogging" }, { "target": "com.amazonaws.cloudtrail#StartQuery" }, + { + "target": "com.amazonaws.cloudtrail#StopImport" + }, { "target": "com.amazonaws.cloudtrail#StopLogging" }, @@ -548,7 +562,25 @@ { "target": "com.amazonaws.cloudtrail#UpdateTrail" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "CloudTrail", + "arnNamespace": "cloudtrail", + "cloudFormationName": "CloudTrail", + "cloudTrailEventSource": "cloudtrail.amazonaws.com", + "endpointPrefix": "cloudtrail" + }, + "aws.auth#sigv4": { + "name": "cloudtrail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
\n \nAs an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see Tools to Build on Amazon Web Services.
\nSee the CloudTrail User \n Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
", + "smithy.api#title": "AWS CloudTrail", + "smithy.api#xmlNamespace": { + "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" + } + } }, "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": { "type": "structure", @@ -893,12 +925,16 @@ "IsMultiRegionTrail": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider\n creating trails that log events in all regions.
" } }, "EnableLogFileValidation": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether log file integrity validation is enabled. The default is false.
\nWhen you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does \n not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. \n For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable \n it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on \n January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
\nSpecifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. \n The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in \n Organizations.
" } }, @@ -1033,7 +1071,7 @@ "Values": { "target": "com.amazonaws.cloudtrail#DataResourceValues", "traits": { - "smithy.api#documentation": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
\nTo log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the \n prefix as arn:aws:s3:::.
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, \n even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
\nTo log data events for all objects in an S3 bucket, specify the bucket and an empty\n object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for\n all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such\n as arn:aws:s3:::bucket-1/example-images. The trail logs data events for\n objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as\n arn:aws:lambda.
This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, \n even if that activity is performed on a function that belongs to another Amazon Web Services account.
To log data events for a specific Lambda function, specify the function ARN.
\nLambda function ARNs are exact. For example, if you specify a \n function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will\n only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will\n not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
\nTo log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix\n as arn:aws:dynamodb.
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
\nTo log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the \n prefix as arn:aws:s3.
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, \n even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
\nTo log data events for all objects in an S3 bucket, specify the bucket and an empty\n object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for\n all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such\n as arn:aws:s3:::bucket-1/example-images. The trail logs data events for\n objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as\n arn:aws:lambda.
This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, \n even if that activity is performed on a function that belongs to another Amazon Web Services account.
To log data events for a specific Lambda function, specify the function ARN.
\nLambda function ARNs are exact. For example, if you specify a \n function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will\n only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will\n not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
\nTo log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix\n as arn:aws:dynamodb.
Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region,\n or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account\n and region replication trails will not be returned. The default is true.
" } } @@ -1342,18 +1385,20 @@ } }, "com.amazonaws.cloudtrail#DestinationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EVENT_DATA_STORE", - "name": "EVENT_DATA_STORE" - }, - { - "value": "AWS_SERVICE", - "name": "AWS_SERVICE" + "type": "enum", + "members": { + "EVENT_DATA_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT_DATA_STORE" } - ] + }, + "AWS_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SERVICE" + } + } } }, "com.amazonaws.cloudtrail#Destinations": { @@ -1441,14 +1486,14 @@ } }, "com.amazonaws.cloudtrail#EventCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "insight", - "name": "Insight" + "type": "enum", + "members": { + "Insight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insight" } - ] + } } }, "com.amazonaws.cloudtrail#EventDataStore": { @@ -1593,6 +1638,26 @@ "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" } }, + "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreHasOngoingImport", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "\n This exception is thrown when you try to update or delete an event data store that currently has an import in progress.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { "type": "structure", "members": { @@ -1644,22 +1709,26 @@ } }, "com.amazonaws.cloudtrail#EventDataStoreStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "PENDING_DELETION", - "name": "PENDING_DELETION" + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "PENDING_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETION" } - ] + } } }, "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { @@ -1700,13 +1769,13 @@ "IncludeManagementEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "Specify if you want your event selector to include management events for your trail.
\n\n For more information, see Management Events in the CloudTrail User Guide.
\n \nBy default, the value is true.
The first copy of management events is free. You are charged for additional copies of management \n events that you are logging on any subsequent trail in the same region. For more information about \n CloudTrail pricing, see CloudTrail Pricing.
" + "smithy.api#documentation": "Specify if you want your event selector to include management events for your trail.
\n\n For more information, see Management Events in the CloudTrail User Guide.
\n \nBy default, the value is true.
The first copy of management events is free. You are charged for additional copies of management \n events that you are logging on any subsequent trail in the same region. For more information about \n CloudTrail pricing, see CloudTrail Pricing.
" } }, "DataResources": { "target": "com.amazonaws.cloudtrail#DataResources", "traits": { - "smithy.api#documentation": "CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, \n and Amazon DynamoDB tables \n with basic event selectors. You can specify up to 250 resources for an individual event\n selector, but the total number of data resources cannot exceed 250 across all event\n selectors in a trail. This limit does not apply if you configure resource logging for all\n data events.
\nFor more information, see Data Events and Limits in CloudTrail \n in the CloudTrail User Guide.
" + "smithy.api#documentation": "CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, \n and Amazon DynamoDB tables \n with basic event selectors. You can specify up to 250 resources for an individual event\n selector, but the total number of data resources cannot exceed 250 across all event\n selectors in a trail. This limit does not apply if you configure resource logging for all\n data events.
\nFor more information, see Data Events and Limits in CloudTrail \n in the CloudTrail User Guide.
" } }, "ExcludeManagementEventSources": { @@ -1942,7 +2011,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the settings for the event selectors that you configured for your trail.\n The information returned for your event selectors includes the following:
\nIf your event selector includes read-only events, write-only events, or\n all events. This applies to both management events and data events.
\nIf your event selector includes management events.
\nIf your event selector includes data events, the resources on which you are logging data\n events.
\nFor more information, see Logging Data and Management Events for Trails\n in the CloudTrail User Guide.
", + "smithy.api#documentation": "Describes the settings for the event selectors that you configured for your trail.\n The information returned for your event selectors includes the following:
\nIf your event selector includes read-only events, write-only events, or\n all events. This applies to both management events and data events.
\nIf your event selector includes management events.
\nIf your event selector includes data events, the resources on which you are logging data\n events.
\nFor more information about logging management and data events, see the following topics in the CloudTrail User Guide:
\n\n Returns information for the specified import.\n
" + } + }, + "com.amazonaws.cloudtrail#GetImportRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "\n The ID for the import.\n
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#GetImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "\n The ID of the import.\n
" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "\n The destination event data store.\n
" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "\n The source S3 bucket.\n
" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n Used with EndEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n Used with StartEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n The status of the import.\n
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of the import's creation.\n
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of when the import was updated.\n
" + } + }, + "ImportStatistics": { + "target": "com.amazonaws.cloudtrail#ImportStatistics", + "traits": { + "smithy.api#documentation": "\n Provides statistics for the import.\n
" + } + } + } + }, "com.amazonaws.cloudtrail#GetInsightSelectors": { "type": "operation", "input": { @@ -2350,47 +2516,86 @@ "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" } }, - "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { + "com.amazonaws.cloudtrail#ImportDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudtrail#ImportFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ImportFailureListItem" + } + }, + "com.amazonaws.cloudtrail#ImportFailureListItem": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", + "Location": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "Brief description of the exception returned by the request.
" + "smithy.api#documentation": "\n The location of the failure in the S3 bucket.\n
" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#ImportFailureStatus", + "traits": { + "smithy.api#documentation": "\n The status of the import. \n
" + } + }, + "ErrorType": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "\n The type of import error.\n
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "\n Provides the reason the import failed.\n
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n When the import was last updated.\n
" } } }, "traits": { - "aws.protocols#awsQueryError": { - "code": "InactiveEventDataStore", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The event data store is inactive.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "\n Provides information about an import failure.\n
" } }, - "com.amazonaws.cloudtrail#InactiveQueryException": { - "type": "structure", + "com.amazonaws.cloudtrail#ImportFailureStatus": { + "type": "enum", "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Brief description of the exception returned by the request.
" + "smithy.api#enumValue": "FAILED" } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InactiveQuery", - "httpResponseCode": 400 }, - "smithy.api#documentation": "The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or\n CANCELLED state.
If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException.
\n The specified import was not found.\n
", "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#httpError": 404 } }, - "com.amazonaws.cloudtrail#InsightSelector": { + "com.amazonaws.cloudtrail#ImportSource": { "type": "structure", "members": { - "InsightType": { - "target": "com.amazonaws.cloudtrail#InsightType", + "S3": { + "target": "com.amazonaws.cloudtrail#S3ImportSource", "traits": { - "smithy.api#documentation": "The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.
\n The source S3 bucket.\n
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A JSON string that contains a list of insight types that are logged on a trail.
" + "smithy.api#documentation": "\n The import source.\n
" } }, - "com.amazonaws.cloudtrail#InsightSelectors": { - "type": "list", + "com.amazonaws.cloudtrail#ImportStatistics": { + "type": "structure", + "members": { + "PrefixesFound": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "\n The number of S3 prefixes found for the import.\n
" + } + }, + "PrefixesCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "\n The number of S3 prefixes that completed import.\n
" + } + }, + "FilesCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "The number of files that completed import.
" + } + }, + "EventsCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "\n The number of trail events imported.\n
" + } + }, + "FailedEntries": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "\n The number of failed entries.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides statistics for the specified ImportID.\n
\n The ID of the import.\n
" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "\n The status of the import. \n
" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "\n The destination event data store.\n
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of the import's creation.\n
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of the import's last update.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Contains information about an import that was returned by a lookup request.\n
" + } + }, + "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveEventDataStore", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The event data store is inactive.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InactiveQueryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveQuery", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or\n CANCELLED state.
Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsightNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException.
The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.
A JSON string that contains a list of insight types that are logged on a trail.
" + } + }, + "com.amazonaws.cloudtrail#InsightSelectors": { + "type": "list", "member": { "target": "com.amazonaws.cloudtrail#InsightSelector" } }, "com.amazonaws.cloudtrail#InsightType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ApiCallRateInsight", - "name": "ApiCallRateInsight" - }, - { - "value": "ApiErrorRateInsight", - "name": "ApiErrorRateInsight" + "type": "enum", + "members": { + "ApiCallRateInsight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApiCallRateInsight" + } + }, + "ApiErrorRateInsight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApiErrorRateInsight" } - ] + } } }, "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException": { @@ -2526,10 +2925,7 @@ } }, "com.amazonaws.cloudtrail#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException": { "type": "structure", @@ -2611,6 +3007,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreCategory", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "\n This exception is thrown when the event data store category is not valid for the import.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { "type": "structure", "members": { @@ -2671,6 +3087,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidImportSourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidImportSource", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "\n This exception is thrown when the provided source S3 bucket is not valid for import.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidInsightSelectorsException": { "type": "structure", "members": { @@ -3084,7 +3520,6 @@ "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 @@ -3160,7 +3595,6 @@ "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 @@ -3190,13 +3624,184 @@ "EventDataStores": { "target": "com.amazonaws.cloudtrail#EventDataStores", "traits": { - "smithy.api#documentation": "Contains information about event data stores in the account, in the current region.
" + "smithy.api#documentation": "Contains information about event data stores in the account, in the current region.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "A token you can use to get the next page of results.
" + } + } + } + }, + "com.amazonaws.cloudtrail#ListImportFailures": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns a list of failures for the specified import.\n
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Failures", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListImportFailuresRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "\n The ID of the import.\n
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount", + "traits": { + "smithy.api#documentation": "\n The maximum number of failures to display on a single page.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "\n A token you can use to get the next page of import failures.\n
" + } + } + } + }, + "com.amazonaws.cloudtrail#ListImportFailuresResponse": { + "type": "structure", + "members": { + "Failures": { + "target": "com.amazonaws.cloudtrail#ImportFailureList", + "traits": { + "smithy.api#documentation": "\n Contains information about the import failures.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "\n A token you can use to get the next page of results.\n
" + } + } + } + }, + "com.amazonaws.cloudtrail#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListImportsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListImportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns information on all imports, or a select set of imports by ImportStatus or Destination.\n
\n The maximum number of imports to display on a single page.\n
" + } + }, + "Destination": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "\n The destination event data store.\n
" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "\n The status of the import.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "\n A token you can use to get the next page of import results.\n
" + } + } + } + }, + "com.amazonaws.cloudtrail#ListImportsResponse": { + "type": "structure", + "members": { + "Imports": { + "target": "com.amazonaws.cloudtrail#ImportsList", + "traits": { + "smithy.api#documentation": "\n The list of returned imports.\n
" } }, "NextToken": { "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { - "smithy.api#documentation": "A token you can use to get the next page of results.
" + "smithy.api#documentation": "\n A token you can use to get the next page of import results.\n
" } } } @@ -3332,7 +3937,6 @@ "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 @@ -3551,10 +4155,7 @@ } }, "com.amazonaws.cloudtrail#Long": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.cloudtrail#LookupAttribute": { "type": "structure", @@ -3579,42 +4180,56 @@ } }, "com.amazonaws.cloudtrail#LookupAttributeKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EventId", - "name": "EVENT_ID" - }, - { - "value": "EventName", - "name": "EVENT_NAME" - }, - { - "value": "ReadOnly", - "name": "READ_ONLY" - }, - { - "value": "Username", - "name": "USERNAME" - }, - { - "value": "ResourceType", - "name": "RESOURCE_TYPE" - }, - { - "value": "ResourceName", - "name": "RESOURCE_NAME" - }, - { - "value": "EventSource", - "name": "EVENT_SOURCE" - }, - { - "value": "AccessKeyId", - "name": "ACCESS_KEY_ID" - } - ] + "type": "enum", + "members": { + "EVENT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventId" + } + }, + "EVENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventName" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadOnly" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Username" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "RESOURCE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceName" + } + }, + "EVENT_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventSource" + } + }, + "ACCESS_KEY_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessKeyId" + } + } } }, "com.amazonaws.cloudtrail#LookupAttributesList": { @@ -3695,6 +4310,8 @@ "MaxResults": { "target": "com.amazonaws.cloudtrail#MaxResults", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 50, "smithy.api#documentation": "The number of events to return. Possible values are 1 through 50. The default is 50.
" } }, @@ -3752,7 +4369,6 @@ "com.amazonaws.cloudtrail#MaxQueryResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 @@ -3762,7 +4378,6 @@ "com.amazonaws.cloudtrail#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 @@ -3976,7 +4591,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures an event selector or advanced event selectors for your trail. \n Use event selectors or advanced event selectors to specify management and data event settings for your trail. By\n default, trails created without specific event selectors are configured to log all read and \n write management events, and no data events.
\nWhen an event occurs in your account, CloudTrail\n evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches \n any event selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.
\nExample
\nYou create an event selector for a trail and specify that you want\n write-only events.
\nThe EC2 GetConsoleOutput and RunInstances API\n operations occur in your account.
CloudTrail evaluates whether the events match your event\n selectors.
\nThe RunInstances is a write-only event and it matches your\n event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't\n match your event selector. The trail doesn't log the event.\n
The PutEventSelectors operation must be called from the region in which\n the trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.
You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails\n and Quotas in CloudTrail \n in the CloudTrail User Guide.
\nYou can add advanced event selectors, and conditions for your advanced \n event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. \n You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors \n to a trail, any existing EventSelectors are overwritten. For more information about \n advanced event selectors, see \n Logging \n data events for trails in the CloudTrail User Guide.
Configures an event selector or advanced event selectors for your trail. \n Use event selectors or advanced event selectors to specify management and data event settings for your trail. By\n default, trails created without specific event selectors are configured to log all read and \n write management events, and no data events.
\nWhen an event occurs in your account, CloudTrail\n evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches \n any event selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.
\nExample
\nYou create an event selector for a trail and specify that you want\n write-only events.
\nThe EC2 GetConsoleOutput and RunInstances API\n operations occur in your account.
CloudTrail evaluates whether the events match your event\n selectors.
\nThe RunInstances is a write-only event and it matches your\n event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't\n match your event selector. The trail doesn't log the event.\n
The PutEventSelectors operation must be called from the region in which\n the trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.
You can configure up to five event selectors for each trail. For more information, see Logging management events for trails\n , Logging data events for trails\n , and Quotas in CloudTrail \n in the CloudTrail User Guide.
\nYou can add advanced event selectors, and conditions for your advanced \n event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. \n You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors \n to a trail, any existing EventSelectors are overwritten. For more information about \n advanced event selectors, see \n Logging \n data events for trails in the CloudTrail User Guide.
\n The URI for the source S3 bucket. \n
", + "smithy.api#required": {} + } + }, + "S3BucketRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "\n The region associated with the source S3 bucket.\n
", + "smithy.api#required": {} + } + }, + "S3BucketAccessRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "\n The IAM ARN role used to access the source S3 bucket.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The settings for the source S3 bucket.\n
" + } + }, "com.amazonaws.cloudtrail#SelectorField": { "type": "string", "traits": { @@ -4696,6 +5353,141 @@ "smithy.api#documentation": "\n Contains configuration information about the service-linked channel.\n
" } }, + "com.amazonaws.cloudtrail#StartImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidImportSourceException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Starts an import of logged trail events from a source S3 bucket to a destination event data store. \n
\n\n When you start a new import, the Destinations and \n ImportSource parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. \n For more information about disabling ACLs, see Controlling ownership of objects and disabling ACLs for your bucket.\n
\n When you retry an import, the ImportID parameter is required.\n
\n The destination event data store. Use this parameter for a new import.\n
" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "\n The source S3 bucket for the import. Use this parameter for a new import.\n
" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n Use with EndEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n Use with StartEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n The ID of the import. Use this parameter when you are retrying an import.\n
" + } + } + } + }, + "com.amazonaws.cloudtrail#StartImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "\n The ID of the import.\n
" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "\n The destination event data store.\n
" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "\n The source S3 bucket.\n
" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n Used with EndEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n Used with StartEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n Shows the status of the import after a StartImport request. An import finishes with a status of COMPLETED if there were no failures, or FAILED \n if there were failures.\n
\n The timestamp for the import's creation.\n
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of the import's last update, if applicable.\n
" + } + } + } + }, "com.amazonaws.cloudtrail#StartLogging": { "type": "operation", "input": { @@ -4816,6 +5608,103 @@ } } }, + "com.amazonaws.cloudtrail#StopImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Stops a specified import. \n
" + } + }, + "com.amazonaws.cloudtrail#StopImportRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "\n The ID of the import.\n
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#StopImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "\n The ID for the import.\n
" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "\n The source S3 bucket.\n
" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "\n The destination event data store.\n
" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "\n The status of the import. \n
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of the import's creation. \n
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n The timestamp of the import's last update.\n
" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "\n Used with EndEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n Used with StartEventTime to bound a StartImport request, and limit imported trail events \n to only those events logged within a specified time period.\n
\n Returns information on the stopped import.\n
" + } + } + } + }, "com.amazonaws.cloudtrail#StopLogging": { "type": "operation", "input": { @@ -4950,10 +5839,7 @@ } }, "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.cloudtrail#Trail": { "type": "structure", @@ -5209,6 +6095,9 @@ { "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + }, { "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, @@ -5261,7 +6150,7 @@ "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { - "smithy.api#documentation": "The advanced event selectors used to select events for the event data store.
" + "smithy.api#documentation": "The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.
" } }, "MultiRegionEnabled": { @@ -5491,12 +6380,16 @@ "IsMultiRegionTrail": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, \n shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region \n where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider\n using trails that log events in all regions.
" } }, "EnableLogFileValidation": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether log file validation is enabled. The default is false.
\nWhen you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail \n does not create digest files for log files that were delivered during a period in which log file integrity validation \n was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on \n January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon \n on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
\nSpecifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. \n The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in \n Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all Amazon Web Services accounts that belong\n to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current Amazon Web Services account but be \n deleted from all member accounts in the organization.
A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document should contain at least 20 characters and must contain fewer than\n 5,000 bytes of UTF-8 encoded characters.
", + "smithy.api#documentation": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.
", "smithy.api#required": {} } } @@ -215,7 +215,7 @@ } ], "traits": { - "smithy.api#documentation": "Inspects the text of a batch of documents for named entities and returns information\n about them. For more information about named entities, see how-entities\n
" + "smithy.api#documentation": "Inspects the text of a batch of documents for named entities and returns information\n about them. For more information about named entities, see\n Entities in the Comprehend Developer Guide.\n
" } }, "com.amazonaws.comprehend#BatchDetectEntitiesItemResult": { @@ -244,7 +244,7 @@ "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { - "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.
", "smithy.api#required": {} } }, @@ -334,7 +334,7 @@ "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { - "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.
", "smithy.api#required": {} } }, @@ -430,7 +430,7 @@ "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { - "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.
\nAmazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text\n and ignores any additional text in the input.
\nInspects the text of a batch of documents for the syntax and part of speech of the words\n in the document and returns information about them. For more information, see how-syntax.
" + "smithy.api#documentation": "Inspects the text of a batch of documents for the syntax and part of speech of the words\n in the document and returns information about them. For more information, see\n Syntax in the Comprehend Developer Guide.\n
" } }, "com.amazonaws.comprehend#BatchDetectSyntaxItemResult": { @@ -520,7 +520,7 @@ "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { - "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size for each document is 5 KB.
", "smithy.api#required": {} } }, @@ -555,6 +555,96 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.comprehend#BatchDetectTargetedSentiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "Inspects a batch of documents and returns a sentiment analysis\n for each entity identified in the documents.
\nFor more information about targeted sentiment, see Targeted sentiment.
" + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentimentItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "The zero-based index of this result in the input list.
" + } + }, + "Entities": { + "target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities", + "traits": { + "smithy.api#documentation": "An array of targeted sentiment entities.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Analysis results for one of the documents in the batch.
" + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentimentRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "A list containing the UTF-8 encoded text of the input documents.\n The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. Currently, English is the only supported language.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentimentResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectTargetedSentimentResult", + "traits": { + "smithy.api#documentation": "A list of objects containing the results of the operation.\n The results are sorted in ascending order by the Index field and match the order of the documents in the input list.\n If all of the documents contain an error, the ResultList is empty.
List of errors that the operation can return.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.comprehend#BatchItemError": { "type": "structure", "members": { @@ -848,6 +938,9 @@ { "target": "com.amazonaws.comprehend#BatchDetectSyntax" }, + { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentiment" + }, { "target": "com.amazonaws.comprehend#ClassifyDocument" }, @@ -932,6 +1025,9 @@ { "target": "com.amazonaws.comprehend#DetectSyntax" }, + { + "target": "com.amazonaws.comprehend#DetectTargetedSentiment" + }, { "target": "com.amazonaws.comprehend#ImportModel" }, @@ -1093,7 +1189,7 @@ "Text": { "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "Creates a new document classification request to analyze a single document in real-time,\n returning personally identifiable information (PII) entity labels.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", "smithy.api#required": {} } }, @@ -1152,7 +1248,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new document classifier that you can use to categorize documents. To create a\n classifier, you provide a set of training documents that labeled with the categories that you\n want to use. After the classifier is trained you can use it to categorize a set of labeled\n documents into the categories. For more information, see how-document-classification.
" + "smithy.api#documentation": "Creates a new document classifier that you can use to categorize documents. To create a\n classifier, you provide a set of training documents that labeled with the categories that you\n want to use. After the classifier is trained you can use it to categorize a set of labeled\n documents into the categories. For more information, see\n Document Classification in the Comprehend Developer Guide.\n
" } }, "com.amazonaws.comprehend#CreateDocumentClassifierRequest": { @@ -2254,7 +2350,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a targeted sentiment detection job. Use this operation \n to get the status of the job.
" + "smithy.api#documentation": "Gets the properties associated with a targeted sentiment detection job. Use this operation\n to get the status of the job.
" } }, "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest": { @@ -2358,7 +2454,7 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "A UTF-8 text string. Each string should contain at least 20 characters and must contain\n fewer that 5,000 bytes of UTF-8 encoded characters.
", + "smithy.api#documentation": "A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
", "smithy.api#required": {} } } @@ -2404,7 +2500,7 @@ } ], "traits": { - "smithy.api#documentation": "Inspects text for named entities, and returns information about them. For more\n information, about named entities, see how-entities.
" + "smithy.api#documentation": "Inspects text for named entities, and returns information about them. For more\n information, about named entities, see\n Entities in the Comprehend Developer Guide.
" } }, "com.amazonaws.comprehend#DetectEntitiesRequest": { @@ -2413,7 +2509,7 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", "smithy.api#required": {} } }, @@ -2437,7 +2533,7 @@ "Entities": { "target": "com.amazonaws.comprehend#ListOfEntities", "traits": { - "smithy.api#documentation": "A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.
\nIf your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see how-entities.
" + "smithy.api#documentation": "A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.
\nIf your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see\n Entities in the Comprehend Developer Guide.\n
" } } }, @@ -2477,7 +2573,7 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, @@ -2536,7 +2632,7 @@ "Text": { "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", "smithy.api#required": {} } }, @@ -2592,7 +2688,7 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 5 KB.
\nAmazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text\n and ignores any additional text in the input.
\nInspects text for syntax and the part of speech of words in the document. For more\n information, how-syntax.
" + "smithy.api#documentation": "Inspects text for syntax and the part of speech of words in the document. For more\n information, see\n Syntax in the Comprehend Developer Guide.\n
" } }, "com.amazonaws.comprehend#DetectSyntaxRequest": { @@ -2657,7 +2753,7 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded\n characters.
", + "smithy.api#documentation": "A UTF-8 string. The maximum string size is 5 KB.
", "smithy.api#required": {} } }, @@ -2676,7 +2772,66 @@ "SyntaxTokens": { "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", "traits": { - "smithy.api#documentation": "A collection of syntax tokens describing the text. For each token, the response provides\n the text, the token type, where the text begins and ends, and the level of confidence that\n Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.
" + "smithy.api#documentation": "A collection of syntax tokens describing the text. For each token, the response provides\n the text, the token type, where the text begins and ends, and the level of confidence that\n Amazon Comprehend has that the token is correct. For a list of token types, see\n Syntax in the Comprehend Developer Guide.\n
" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectTargetedSentiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectTargetedSentimentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectTargetedSentimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "Inspects the input text and returns a sentiment analysis for each entity identified in the text.
\nFor more information about targeted sentiment, see Targeted sentiment.
" + } + }, + "com.amazonaws.comprehend#DetectTargetedSentimentRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "A UTF-8 text string. The maximum string length is 5 KB.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. Currently, English is the only supported language.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#DetectTargetedSentimentResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities", + "traits": { + "smithy.api#documentation": "Targeted sentiment analysis for each of the entities identified in the input text.
" } } }, @@ -2919,7 +3074,7 @@ "TestS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region\n as the API endpoint that you are calling. The URI can point to a single input file or it can\n provide the prefix for a collection of input files.
" + "smithy.api#documentation": "This specifies the Amazon S3 location where the test annotations for an entity recognizer\n are located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.
" } }, "LabelDelimiter": { @@ -2936,7 +3091,7 @@ } }, "traits": { - "smithy.api#documentation": "The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see prep-classifier-data.
" + "smithy.api#documentation": "The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see\n Preparing training data in the Comprehend Developer Guide.\n
" } }, "com.amazonaws.comprehend#DocumentClassifierMode": { @@ -3670,13 +3825,13 @@ "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "A character offset in the input text that shows where the entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.
" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the first character in the\n entity.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "A character offset in the input text that shows where the entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.
" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the last character in the\n entity.
" } } }, @@ -3717,7 +3872,7 @@ "TestS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "This specifies the Amazon S3 location where the test annotations for an entity recognizer\n are located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.
" + "smithy.api#documentation": "Specifies the Amazon S3 location where the test annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.
" } } }, @@ -3826,7 +3981,7 @@ "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, \n where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, \n where 1 is the best score. \n
A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100,\n where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1,\n where 1 is the best score.\n
A character offset in the input text that shows where the key phrase begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.
" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the first character in the\n key phrase.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "A character offset in the input text where the key phrase ends. The offset returns the\n position of each UTF-8 code point in the string. A code point is the abstract\n character from a particular graphical representation. For example, a multi-byte UTF-8\n character maps to a single code point.
The zero-based offset from the beginning of the source text to the last character in the\n key phrase.
" } } }, @@ -5562,6 +5717,12 @@ "target": "com.amazonaws.comprehend#DocumentClass" } }, + "com.amazonaws.comprehend#ListOfDescriptiveMentionIndices": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Integer" + } + }, "com.amazonaws.comprehend#ListOfDetectDominantLanguageResult": { "type": "list", "member": { @@ -5592,6 +5753,12 @@ "target": "com.amazonaws.comprehend#BatchDetectSyntaxItemResult" } }, + "com.amazonaws.comprehend#ListOfDetectTargetedSentimentResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentItemResult" + } + }, "com.amazonaws.comprehend#ListOfDocumentReadFeatureTypes": { "type": "list", "member": { @@ -5634,6 +5801,12 @@ "target": "com.amazonaws.comprehend#DocumentLabel" } }, + "com.amazonaws.comprehend#ListOfMentions": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TargetedSentimentMention" + } + }, "com.amazonaws.comprehend#ListOfPiiEntities": { "type": "list", "member": { @@ -5652,6 +5825,12 @@ "target": "com.amazonaws.comprehend#SyntaxToken" } }, + "com.amazonaws.comprehend#ListOfTargetedSentimentEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TargetedSentimentEntity" + } + }, "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs": { "type": "operation", "input": { @@ -6003,6 +6182,23 @@ } } }, + "com.amazonaws.comprehend#MentionSentiment": { + "type": "structure", + "members": { + "Sentiment": { + "target": "com.amazonaws.comprehend#SentimentType", + "traits": { + "smithy.api#documentation": "The sentiment of the mention.
" + } + }, + "SentimentScore": { + "target": "com.amazonaws.comprehend#SentimentScore" + } + }, + "traits": { + "smithy.api#documentation": "Contains the sentiment and sentiment score for one mention of an entity.
\nFor more information about targeted sentiment, see Targeted sentiment.
" + } + }, "com.amazonaws.comprehend#ModelStatus": { "type": "string", "traits": { @@ -6054,7 +6250,7 @@ "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.
\n For a PII entity detection job, the output file is plain text, not a compressed archive. \n The output file name is the same as the input file, with .out appended at the end.\n
When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.
\n For a PII entity detection job, the output file is plain text, not a compressed archive.\n The output file name is the same as the input file, with .out appended at the end.\n
Identifies the part of speech represented by the token and gives the confidence that\n Amazon Comprehend has that the part of speech was correctly identified. For more information\n about the parts of speech that Amazon Comprehend can identify, see how-syntax.
" + "smithy.api#documentation": "Identifies the part of speech represented by the token and gives the confidence that\n Amazon Comprehend has that the part of speech was correctly identified. For more information\n about the parts of speech that Amazon Comprehend can identify, see\n Syntax in the Comprehend Developer Guide.\n
" } }, "com.amazonaws.comprehend#PartOfSpeechTagType": { @@ -6340,13 +6536,13 @@ "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "A character offset in the input text that shows where the PII entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.
" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the first character in the\n entity.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "A character offset in the input text that shows where the PII entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.
" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the last character in the\n entity.
" } } }, @@ -6515,7 +6711,7 @@ "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.
\n For a PII entity detection job, the output file is plain text, not a compressed archive. \n The output file name is the same as the input file, with .out appended at the end.\n
When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.
\n For a PII entity detection job, the output file is plain text, not a compressed archive.\n The output file name is the same as the input file, with .out appended at the end.\n
The language of the input documents. Currently, English is the only valid language.
", + "smithy.api#documentation": "The language of the input documents. Currently, English is the only supported language.
", "smithy.api#required": {} } }, @@ -8498,7 +8694,7 @@ "PartOfSpeech": { "target": "com.amazonaws.comprehend#PartOfSpeechTag", "traits": { - "smithy.api#documentation": "Provides the part of speech label and the confidence level that Amazon Comprehend has that\n the part of speech was correctly identified. For more information, see how-syntax.
" + "smithy.api#documentation": "Provides the part of speech label and the confidence level that Amazon Comprehend has that\n the part of speech was correctly identified. For more information, see\n Syntax in the Comprehend Developer Guide.\n
" } } }, @@ -8718,7 +8914,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the \n targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the\n targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
One or more index into the Mentions array that provides the best name for the entity group.
" + } + }, + "Mentions": { + "target": "com.amazonaws.comprehend#ListOfMentions", + "traits": { + "smithy.api#documentation": "An array of mentions of the entity in the document. The array represents a co-reference group.\n See \n Co-reference group for an example.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about one of the entities found by targeted sentiment analysis.
\nFor more information about targeted sentiment, see Targeted sentiment.
" + } + }, + "com.amazonaws.comprehend#TargetedSentimentEntityType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PERSON", + "name": "PERSON" + }, + { + "value": "LOCATION", + "name": "LOCATION" + }, + { + "value": "ORGANIZATION", + "name": "ORGANIZATION" + }, + { + "value": "FACILITY", + "name": "FACILITY" + }, + { + "value": "BRAND", + "name": "BRAND" + }, + { + "value": "COMMERCIAL_ITEM", + "name": "COMMERCIAL_ITEM" + }, + { + "value": "MOVIE", + "name": "MOVIE" + }, + { + "value": "MUSIC", + "name": "MUSIC" + }, + { + "value": "BOOK", + "name": "BOOK" + }, + { + "value": "SOFTWARE", + "name": "SOFTWARE" + }, + { + "value": "GAME", + "name": "GAME" + }, + { + "value": "PERSONAL_TITLE", + "name": "PERSONAL_TITLE" + }, + { + "value": "EVENT", + "name": "EVENT" + }, + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "QUANTITY", + "name": "QUANTITY" + }, + { + "value": "ATTRIBUTE", + "name": "ATTRIBUTE" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.comprehend#TargetedSentimentMention": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
" + } + }, + "GroupScore": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "The confidence that all the entities mentioned in the group relate to the same entity.
" + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "The text in the document that identifies the entity.
" + } + }, + "Type": { + "target": "com.amazonaws.comprehend#TargetedSentimentEntityType", + "traits": { + "smithy.api#documentation": "The type of the entity. Amazon Comprehend supports a variety of entity types.
" + } + }, + "MentionSentiment": { + "target": "com.amazonaws.comprehend#MentionSentiment", + "traits": { + "smithy.api#documentation": "Contains the sentiment and sentiment score for the mention.
" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "The offset into the document text where the mention begins.
" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "The offset into the document text where the mention ends.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about one mention of an entity. The mention information includes the location of the mention\n in the text and the sentiment of the mention.
\nFor more information about targeted sentiment, see Targeted sentiment.
" + } + }, "com.amazonaws.comprehend#TextSizeLimitExceededException": { "type": "structure", "members": { @@ -8922,7 +9263,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon Comprehend can't process the language of the input text. For custom entity\n recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.\n For a list of supported languages, see supported-languages.
", + "smithy.api#documentation": "Amazon Comprehend can't process the language of the input text. For custom entity\n recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.\n For a list of supported languages,\n Supported languages in the Comprehend Developer Guide.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk/aws-models/cost-and-usage-report-service.json b/codegen/sdk/aws-models/cost-and-usage-report-service.json index f97282b9a5e..0d3dcf946f2 100644 --- a/codegen/sdk/aws-models/cost-and-usage-report-service.json +++ b/codegen/sdk/aws-models/cost-and-usage-report-service.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -63,123 +63,193 @@ } }, "com.amazonaws.costandusagereportservice#AWSRegion": { - "type": "string", + "type": "enum", + "members": { + "CAPE_TOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "HONG_KONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "MUMBAI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "SINGAPORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "SYDNEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "JAKARTA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "TOKYO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "SEOUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "OSAKA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "CANADA_CENTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "FRANKFURT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "IRELAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "LONDON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "PARIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "STOCKHOLM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "MILANO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "SPAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "UAE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "BAHRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "SAO_PAULO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "US_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "OHIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "NORTHERN_CALIFORNIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "OREGON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "BEIJING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "NINGXIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + } + }, "traits": { - "smithy.api#documentation": "The region of the S3 bucket that AWS delivers the report into.
", - "smithy.api#enum": [ - { - "value": "af-south-1", - "name": "CAPE_TOWN" - }, - { - "value": "ap-east-1", - "name": "HONG_KONG" - }, - { - "value": "ap-south-1", - "name": "MUMBAI" - }, - { - "value": "ap-southeast-1", - "name": "SINGAPORE" - }, - { - "value": "ap-southeast-2", - "name": "SYDNEY" - }, - { - "value": "ap-northeast-1", - "name": "TOKYO" - }, - { - "value": "ap-northeast-2", - "name": "SEOUL" - }, - { - "value": "ap-northeast-3", - "name": "OSAKA" - }, - { - "value": "ca-central-1", - "name": "CANADA_CENTRAL" - }, - { - "value": "eu-central-1", - "name": "FRANKFURT" - }, - { - "value": "eu-west-1", - "name": "IRELAND" - }, - { - "value": "eu-west-2", - "name": "LONDON" - }, - { - "value": "eu-west-3", - "name": "PARIS" - }, - { - "value": "eu-north-1", - "name": "STOCKHOLM" - }, - { - "value": "eu-south-1", - "name": "MILANO" - }, - { - "value": "me-south-1", - "name": "BAHRAIN" - }, - { - "value": "sa-east-1", - "name": "SAO_PAULO" - }, - { - "value": "us-east-1", - "name": "US_STANDARD" - }, - { - "value": "us-east-2", - "name": "OHIO" - }, - { - "value": "us-west-1", - "name": "NORTHERN_CALIFORNIA" - }, - { - "value": "us-west-2", - "name": "OREGON" - }, - { - "value": "cn-north-1", - "name": "BEIJING" - }, - { - "value": "cn-northwest-1", - "name": "NINGXIA" - } - ] + "smithy.api#documentation": "The region of the S3 bucket that AWS delivers the report into.
" } }, "com.amazonaws.costandusagereportservice#AdditionalArtifact": { - "type": "string", - "traits": { - "smithy.api#documentation": "The types of manifest that you want AWS to create for this report.
", - "smithy.api#enum": [ - { - "value": "REDSHIFT", - "name": "REDSHIFT" - }, - { - "value": "QUICKSIGHT", - "name": "QUICKSIGHT" - }, - { - "value": "ATHENA", - "name": "ATHENA" + "type": "enum", + "members": { + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + }, + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" } - ] + }, + "ATHENA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATHENA" + } + } + }, + "traits": { + "smithy.api#documentation": "The types of manifest that you want AWS to create for this report.
" } }, "com.amazonaws.costandusagereportservice#AdditionalArtifactList": { @@ -198,27 +268,33 @@ "min": 0, "max": 128 }, - "smithy.api#pattern": "(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\\+=\\.\\-@].{1,30}" + "smithy.api#pattern": "^(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\\+=\\.\\-@].{1,30}$" } }, "com.amazonaws.costandusagereportservice#CompressionFormat": { - "type": "string", - "traits": { - "smithy.api#documentation": "The compression format that AWS uses for the report.
", - "smithy.api#enum": [ - { - "value": "ZIP", - "name": "ZIP" - }, - { - "value": "GZIP", - "name": "GZIP" - }, - { - "value": "Parquet", - "name": "Parquet" + "type": "enum", + "members": { + "ZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZIP" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" } - ] + }, + "Parquet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Parquet" + } + } + }, + "traits": { + "smithy.api#documentation": "The compression format that AWS uses for the report.
" } }, "com.amazonaws.costandusagereportservice#DeleteReportDefinition": { @@ -351,7 +427,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[A-Za-z0-9_\\.\\-=]*" + "smithy.api#pattern": "^[A-Za-z0-9_\\.\\-=]*$" } }, "com.amazonaws.costandusagereportservice#InternalErrorException": { @@ -369,7 +445,6 @@ "com.amazonaws.costandusagereportservice#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of results that AWS returns for the operation.
", "smithy.api#range": { "min": 5, @@ -467,10 +542,7 @@ } }, "com.amazonaws.costandusagereportservice#RefreshClosedReports": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.costandusagereportservice#ReportDefinition": { "type": "structure", @@ -563,19 +635,23 @@ } }, "com.amazonaws.costandusagereportservice#ReportFormat": { - "type": "string", - "traits": { - "smithy.api#documentation": "The format that AWS saves the report in.
", - "smithy.api#enum": [ - { - "value": "textORcsv", - "name": "CSV" - }, - { - "value": "Parquet", - "name": "Parquet" + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "textORcsv" } - ] + }, + "Parquet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Parquet" + } + } + }, + "traits": { + "smithy.api#documentation": "The format that AWS saves the report in.
" } }, "com.amazonaws.costandusagereportservice#ReportLimitReachedException": { @@ -598,22 +674,24 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[0-9A-Za-z!\\-_.*\\'()]+" + "smithy.api#pattern": "^[0-9A-Za-z!\\-_.*\\'()]+$" } }, "com.amazonaws.costandusagereportservice#ReportVersioning": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_NEW_REPORT", - "name": "CREATE_NEW_REPORT" - }, - { - "value": "OVERWRITE_REPORT", - "name": "OVERWRITE_REPORT" + "type": "enum", + "members": { + "CREATE_NEW_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_NEW_REPORT" } - ] + }, + "OVERWRITE_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE_REPORT" + } + } } }, "com.amazonaws.costandusagereportservice#S3Bucket": { @@ -624,7 +702,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[A-Za-z0-9_\\.\\-]+" + "smithy.api#pattern": "^[A-Za-z0-9_\\.\\-]+$" } }, "com.amazonaws.costandusagereportservice#S3Prefix": { @@ -635,19 +713,21 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[0-9A-Za-z!\\-_.*\\'()/]*" + "smithy.api#pattern": "^[0-9A-Za-z!\\-_.*\\'()/]*$" } }, "com.amazonaws.costandusagereportservice#SchemaElement": { - "type": "string", - "traits": { - "smithy.api#documentation": "Whether or not AWS includes resource IDs in the report.
", - "smithy.api#enum": [ - { - "value": "RESOURCES", - "name": "RESOURCES" + "type": "enum", + "members": { + "RESOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCES" } - ] + } + }, + "traits": { + "smithy.api#documentation": "Whether or not AWS includes resource IDs in the report.
" } }, "com.amazonaws.costandusagereportservice#SchemaElementList": { @@ -660,23 +740,29 @@ } }, "com.amazonaws.costandusagereportservice#TimeUnit": { - "type": "string", + "type": "enum", + "members": { + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + }, "traits": { - "smithy.api#documentation": "The length of time covered by the report.
", - "smithy.api#enum": [ - { - "value": "HOURLY", - "name": "HOURLY" - }, - { - "value": "DAILY", - "name": "DAILY" - }, - { - "value": "MONTHLY", - "name": "MONTHLY" - } - ] + "smithy.api#documentation": "The length of time covered by the report.
" } }, "com.amazonaws.costandusagereportservice#ValidationException": { diff --git a/codegen/sdk/aws-models/cost-explorer.json b/codegen/sdk/aws-models/cost-explorer.json index edde716aa17..62f63285045 100644 --- a/codegen/sdk/aws-models/cost-explorer.json +++ b/codegen/sdk/aws-models/cost-explorer.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -31,21 +31,6 @@ "shapes": { "com.amazonaws.costexplorer#AWSInsightsIndexService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Cost Explorer", - "arnNamespace": "ce", - "cloudFormationName": "CostExplorer", - "cloudTrailEventSource": "costexplorer.amazonaws.com", - "endpointPrefix": "ce" - }, - "aws.auth#sigv4": { - "name": "ce" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "You can use the Cost Explorer API to programmatically query your cost and usage data. You\n can query for aggregated data such as total monthly costs or total daily usage. You can also\n query for granular data. This might include the number of daily write operations for Amazon\n DynamoDB database tables in your production environment.
\n\t\tService Endpoint
\n\t\tThe Cost Explorer API provides the following endpoint:
\n\t\t\n https://ce.us-east-1.amazonaws.com\n
For information about the costs that are associated with the Cost Explorer API, see\n Amazon Web Services Cost\n Management Pricing.
", - "smithy.api#title": "AWS Cost Explorer Service" - }, "version": "2017-10-25", "operations": [ { @@ -153,21 +138,38 @@ { "target": "com.amazonaws.costexplorer#UpdateCostCategoryDefinition" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Cost Explorer", + "arnNamespace": "ce", + "cloudFormationName": "CostExplorer", + "cloudTrailEventSource": "costexplorer.amazonaws.com", + "endpointPrefix": "ce" + }, + "aws.auth#sigv4": { + "name": "ce" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "You can use the Cost Explorer API to programmatically query your cost and usage data. You\n can query for aggregated data such as total monthly costs or total daily usage. You can also\n query for granular data. This might include the number of daily write operations for Amazon\n DynamoDB database tables in your production environment.
\n\t\tService Endpoint
\n\t\tThe Cost Explorer API provides the following endpoint:
\n\t\t\n https://ce.us-east-1.amazonaws.com\n
For information about the costs that are associated with the Cost Explorer API, see\n Amazon Web Services Cost\n Management Pricing.
", + "smithy.api#title": "AWS Cost Explorer Service" + } }, "com.amazonaws.costexplorer#AccountScope": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PAYER", - "name": "PAYER" - }, - { - "value": "LINKED", - "name": "LINKED" + "type": "enum", + "members": { + "PAYER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYER" } - ] + }, + "LINKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED" + } + } } }, "com.amazonaws.costexplorer#AmortizedRecurringFee": { @@ -270,22 +272,26 @@ } }, "com.amazonaws.costexplorer#AnomalyFeedbackType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "YES", - "name": "YES" - }, - { - "value": "NO", - "name": "NO" - }, - { - "value": "PLANNED_ACTIVITY", - "name": "PLANNED_ACTIVITY" + "type": "enum", + "members": { + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YES" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" } - ] + }, + "PLANNED_ACTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLANNED_ACTIVITY" + } + } } }, "com.amazonaws.costexplorer#AnomalyMonitor": { @@ -341,6 +347,7 @@ "DimensionalValueCount": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The value for evaluated dimensions.
" } } @@ -361,6 +368,7 @@ "MaxScore": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum score that's observed during the AnomalyDateInterval.
The last observed score.
", "smithy.api#required": {} } @@ -433,22 +442,26 @@ } }, "com.amazonaws.costexplorer#AnomalySubscriptionFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DAILY", - "name": "DAILY" - }, - { - "value": "IMMEDIATE", - "name": "IMMEDIATE" - }, - { - "value": "WEEKLY", - "name": "WEEKLY" + "type": "enum", + "members": { + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "IMMEDIATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMMEDIATE" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" } - ] + } } }, "com.amazonaws.costexplorer#AnomalySubscriptions": { @@ -495,22 +508,26 @@ } }, "com.amazonaws.costexplorer#Context": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COST_AND_USAGE", - "name": "COST_AND_USAGE" - }, - { - "value": "RESERVATIONS", - "name": "RESERVATIONS" - }, - { - "value": "SAVINGS_PLANS", - "name": "SAVINGS_PLANS" + "type": "enum", + "members": { + "COST_AND_USAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_AND_USAGE" } - ] + }, + "RESERVATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVATIONS" + } + }, + "SAVINGS_PLANS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS" + } + } } }, "com.amazonaws.costexplorer#CostAllocationTag": { @@ -567,18 +584,20 @@ } }, "com.amazonaws.costexplorer#CostAllocationTagStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "Inactive", - "name": "INACTIVE" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" } - ] + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } } }, "com.amazonaws.costexplorer#CostAllocationTagStatusEntry": { @@ -616,23 +635,26 @@ } }, "com.amazonaws.costexplorer#CostAllocationTagType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWSGenerated", - "name": "AWS_GENERATED" - }, - { - "value": "UserDefined", - "name": "USER_DEFINED" + "type": "enum", + "members": { + "AWS_GENERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSGenerated" + } + }, + "USER_DEFINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UserDefined" } - ] + } } }, "com.amazonaws.costexplorer#CostAllocationTagsMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000 @@ -652,14 +674,14 @@ "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "The effective state data of your Cost Category.
", + "smithy.api#documentation": "The effective start date of your Cost Category.
", "smithy.api#required": {} } }, "EffectiveEnd": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "The effective end data of your Cost Category.
" + "smithy.api#documentation": "The effective end date of your Cost Category.
" } }, "Name": { @@ -722,23 +744,26 @@ } }, "com.amazonaws.costexplorer#CostCategoryInheritedValueDimensionName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LINKED_ACCOUNT_NAME", - "name": "LINKED_ACCOUNT_NAME" - }, - { - "value": "TAG", - "name": "TAG" + "type": "enum", + "members": { + "LINKED_ACCOUNT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED_ACCOUNT_NAME" } - ] + }, + "TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAG" + } + } } }, "com.amazonaws.costexplorer#CostCategoryMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -815,6 +840,7 @@ "NumberOfRules": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of rules that are associated with a specific Cost Category.
" } }, @@ -874,30 +900,34 @@ } }, "com.amazonaws.costexplorer#CostCategoryRuleType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REGULAR", - "name": "REGULAR" - }, - { - "value": "INHERITED_VALUE", - "name": "INHERITED_VALUE" + "type": "enum", + "members": { + "REGULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGULAR" } - ] + }, + "INHERITED_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INHERITED_VALUE" + } + } } }, "com.amazonaws.costexplorer#CostCategoryRuleVersion": { - "type": "string", - "traits": { - "smithy.api#documentation": "The rule schema version in this particular Cost Category.
", - "smithy.api#enum": [ - { - "value": "CostCategoryExpression.v1", - "name": "CostCategoryExpressionV1" + "type": "enum", + "members": { + "CostCategoryExpressionV1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CostCategoryExpression.v1" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The rule schema version in this particular Cost Category.
" } }, "com.amazonaws.costexplorer#CostCategoryRulesList": { @@ -913,22 +943,26 @@ } }, "com.amazonaws.costexplorer#CostCategorySplitChargeMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FIXED", - "name": "FIXED" - }, - { - "value": "PROPORTIONAL", - "name": "PROPORTIONAL" - }, - { - "value": "EVEN", - "name": "EVEN" + "type": "enum", + "members": { + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + }, + "PROPORTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROPORTIONAL" } - ] + }, + "EVEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVEN" + } + } } }, "com.amazonaws.costexplorer#CostCategorySplitChargeRule": { @@ -989,14 +1023,14 @@ } }, "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALLOCATION_PERCENTAGES", - "name": "ALLOCATION_PERCENTAGES" + "type": "enum", + "members": { + "ALLOCATION_PERCENTAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOCATION_PERCENTAGES" } - ] + } } }, "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameterValuesList": { @@ -1048,29 +1082,31 @@ } }, "com.amazonaws.costexplorer#CostCategoryStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "APPLIED", - "name": "APPLIED" + "type": "enum", + "members": { + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" } - ] + }, + "APPLIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLIED" + } + } } }, "com.amazonaws.costexplorer#CostCategoryStatusComponent": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COST_EXPLORER", - "name": "COST_EXPLORER" + "type": "enum", + "members": { + "COST_EXPLORER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_EXPLORER" } - ] + } } }, "com.amazonaws.costexplorer#CostCategoryValue": { @@ -1381,6 +1417,12 @@ "smithy.api#required": {} } }, + "EffectiveStart": { + "target": "com.amazonaws.costexplorer#ZonedDateTime", + "traits": { + "smithy.api#documentation": "The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.
" + } + }, "RuleVersion": { "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", "traits": { @@ -1423,7 +1465,7 @@ "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "The Cost Category's effective start date.
" + "smithy.api#documentation": "The Cost Category's effective start date. It can only be a billing start date (first day of the month).
" } } } @@ -1704,138 +1746,200 @@ } }, "com.amazonaws.costexplorer#Dimension": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AZ", - "name": "AZ" - }, - { - "value": "INSTANCE_TYPE", - "name": "INSTANCE_TYPE" - }, - { - "value": "LINKED_ACCOUNT", - "name": "LINKED_ACCOUNT" - }, - { - "value": "LINKED_ACCOUNT_NAME", - "name": "LINKED_ACCOUNT_NAME" - }, - { - "value": "OPERATION", - "name": "OPERATION" - }, - { - "value": "PURCHASE_TYPE", - "name": "PURCHASE_TYPE" - }, - { - "value": "REGION", - "name": "REGION" - }, - { - "value": "SERVICE", - "name": "SERVICE" - }, - { - "value": "SERVICE_CODE", - "name": "SERVICE_CODE" - }, - { - "value": "USAGE_TYPE", - "name": "USAGE_TYPE" - }, - { - "value": "USAGE_TYPE_GROUP", - "name": "USAGE_TYPE_GROUP" - }, - { - "value": "RECORD_TYPE", - "name": "RECORD_TYPE" - }, - { - "value": "OPERATING_SYSTEM", - "name": "OPERATING_SYSTEM" - }, - { - "value": "TENANCY", - "name": "TENANCY" - }, - { - "value": "SCOPE", - "name": "SCOPE" - }, - { - "value": "PLATFORM", - "name": "PLATFORM" - }, - { - "value": "SUBSCRIPTION_ID", - "name": "SUBSCRIPTION_ID" - }, - { - "value": "LEGAL_ENTITY_NAME", - "name": "LEGAL_ENTITY_NAME" - }, - { - "value": "DEPLOYMENT_OPTION", - "name": "DEPLOYMENT_OPTION" - }, - { - "value": "DATABASE_ENGINE", - "name": "DATABASE_ENGINE" - }, - { - "value": "CACHE_ENGINE", - "name": "CACHE_ENGINE" - }, - { - "value": "INSTANCE_TYPE_FAMILY", - "name": "INSTANCE_TYPE_FAMILY" - }, - { - "value": "BILLING_ENTITY", - "name": "BILLING_ENTITY" - }, - { - "value": "RESERVATION_ID", - "name": "RESERVATION_ID" - }, - { - "value": "RESOURCE_ID", - "name": "RESOURCE_ID" - }, - { - "value": "RIGHTSIZING_TYPE", - "name": "RIGHTSIZING_TYPE" - }, - { - "value": "SAVINGS_PLANS_TYPE", - "name": "SAVINGS_PLANS_TYPE" - }, - { - "value": "SAVINGS_PLAN_ARN", - "name": "SAVINGS_PLAN_ARN" - }, - { - "value": "PAYMENT_OPTION", - "name": "PAYMENT_OPTION" - }, - { - "value": "AGREEMENT_END_DATE_TIME_AFTER", - "name": "AGREEMENT_END_DATE_TIME_AFTER" - }, - { - "value": "AGREEMENT_END_DATE_TIME_BEFORE", - "name": "AGREEMENT_END_DATE_TIME_BEFORE" - }, - { - "value": "INVOICING_ENTITY", - "name": "INVOICING_ENTITY" - } - ] + "type": "enum", + "members": { + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "INSTANCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_TYPE" + } + }, + "LINKED_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED_ACCOUNT" + } + }, + "LINKED_ACCOUNT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED_ACCOUNT_NAME" + } + }, + "OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION" + } + }, + "PURCHASE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PURCHASE_TYPE" + } + }, + "REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGION" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + }, + "SERVICE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_CODE" + } + }, + "USAGE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE" + } + }, + "USAGE_TYPE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE_GROUP" + } + }, + "RECORD_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECORD_TYPE" + } + }, + "OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATING_SYSTEM" + } + }, + "TENANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TENANCY" + } + }, + "SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE" + } + }, + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM" + } + }, + "SUBSCRIPTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION_ID" + } + }, + "LEGAL_ENTITY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGAL_ENTITY_NAME" + } + }, + "DEPLOYMENT_OPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_OPTION" + } + }, + "DATABASE_ENGINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATABASE_ENGINE" + } + }, + "CACHE_ENGINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CACHE_ENGINE" + } + }, + "INSTANCE_TYPE_FAMILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_TYPE_FAMILY" + } + }, + "BILLING_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLING_ENTITY" + } + }, + "RESERVATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVATION_ID" + } + }, + "RESOURCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ID" + } + }, + "RIGHTSIZING_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHTSIZING_TYPE" + } + }, + "SAVINGS_PLANS_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS_TYPE" + } + }, + "SAVINGS_PLAN_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLAN_ARN" + } + }, + "PAYMENT_OPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYMENT_OPTION" + } + }, + "AGREEMENT_END_DATE_TIME_AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGREEMENT_END_DATE_TIME_AFTER" + } + }, + "AGREEMENT_END_DATE_TIME_BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGREEMENT_END_DATE_TIME_BEFORE" + } + }, + "INVOICING_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVOICING_ENTITY" + } + } } }, "com.amazonaws.costexplorer#DimensionValues": { @@ -1844,7 +1948,7 @@ "Key": { "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.
The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.
Determines whether the recommendation is for a current-generation instance.
" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommended reservation is size flexible.
" } } @@ -2154,12 +2260,14 @@ "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommendation is for a current-generation instance.
" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommended reservation is size flexible.
" } } @@ -2198,12 +2306,14 @@ "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommendation is for a current generation instance.
" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommended reservation is size flexible.
" } } @@ -2219,7 +2329,10 @@ "type": "string" }, "com.amazonaws.costexplorer#Estimated": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.costexplorer#Expression": { "type": "structure", @@ -2272,74 +2385,104 @@ } }, "com.amazonaws.costexplorer#FindingReasonCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CPU_OVER_PROVISIONED", - "name": "CPU_OVER_PROVISIONED" - }, - { - "value": "CPU_UNDER_PROVISIONED", - "name": "CPU_UNDER_PROVISIONED" - }, - { - "value": "MEMORY_OVER_PROVISIONED", - "name": "MEMORY_OVER_PROVISIONED" - }, - { - "value": "MEMORY_UNDER_PROVISIONED", - "name": "MEMORY_UNDER_PROVISIONED" - }, - { - "value": "EBS_THROUGHPUT_OVER_PROVISIONED", - "name": "EBS_THROUGHPUT_OVER_PROVISIONED" - }, - { - "value": "EBS_THROUGHPUT_UNDER_PROVISIONED", - "name": "EBS_THROUGHPUT_UNDER_PROVISIONED" - }, - { - "value": "EBS_IOPS_OVER_PROVISIONED", - "name": "EBS_IOPS_OVER_PROVISIONED" - }, - { - "value": "EBS_IOPS_UNDER_PROVISIONED", - "name": "EBS_IOPS_UNDER_PROVISIONED" - }, - { - "value": "NETWORK_BANDWIDTH_OVER_PROVISIONED", - "name": "NETWORK_BANDWIDTH_OVER_PROVISIONED" - }, - { - "value": "NETWORK_BANDWIDTH_UNDER_PROVISIONED", - "name": "NETWORK_BANDWIDTH_UNDER_PROVISIONED" - }, - { - "value": "NETWORK_PPS_OVER_PROVISIONED", - "name": "NETWORK_PPS_OVER_PROVISIONED" - }, - { - "value": "NETWORK_PPS_UNDER_PROVISIONED", - "name": "NETWORK_PPS_UNDER_PROVISIONED" - }, - { - "value": "DISK_IOPS_OVER_PROVISIONED", - "name": "DISK_IOPS_OVER_PROVISIONED" - }, - { - "value": "DISK_IOPS_UNDER_PROVISIONED", - "name": "DISK_IOPS_UNDER_PROVISIONED" - }, - { - "value": "DISK_THROUGHPUT_OVER_PROVISIONED", - "name": "DISK_THROUGHPUT_OVER_PROVISIONED" - }, - { - "value": "DISK_THROUGHPUT_UNDER_PROVISIONED", - "name": "DISK_THROUGHPUT_UNDER_PROVISIONED" - } - ] + "type": "enum", + "members": { + "CPU_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU_OVER_PROVISIONED" + } + }, + "CPU_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU_UNDER_PROVISIONED" + } + }, + "MEMORY_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMORY_OVER_PROVISIONED" + } + }, + "MEMORY_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMORY_UNDER_PROVISIONED" + } + }, + "EBS_THROUGHPUT_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_THROUGHPUT_OVER_PROVISIONED" + } + }, + "EBS_THROUGHPUT_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_THROUGHPUT_UNDER_PROVISIONED" + } + }, + "EBS_IOPS_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_IOPS_OVER_PROVISIONED" + } + }, + "EBS_IOPS_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_IOPS_UNDER_PROVISIONED" + } + }, + "NETWORK_BANDWIDTH_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_BANDWIDTH_OVER_PROVISIONED" + } + }, + "NETWORK_BANDWIDTH_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_BANDWIDTH_UNDER_PROVISIONED" + } + }, + "NETWORK_PPS_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_PPS_OVER_PROVISIONED" + } + }, + "NETWORK_PPS_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_PPS_UNDER_PROVISIONED" + } + }, + "DISK_IOPS_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISK_IOPS_OVER_PROVISIONED" + } + }, + "DISK_IOPS_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISK_IOPS_UNDER_PROVISIONED" + } + }, + "DISK_THROUGHPUT_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISK_THROUGHPUT_OVER_PROVISIONED" + } + }, + "DISK_THROUGHPUT_UNDER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISK_THROUGHPUT_UNDER_PROVISIONED" + } + } } }, "com.amazonaws.costexplorer#FindingReasonCodes": { @@ -2387,10 +2530,16 @@ } }, "com.amazonaws.costexplorer#GenericBoolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.costexplorer#GenericDouble": { - "type": "double" + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.costexplorer#GenericString": { "type": "string", @@ -2879,6 +3028,7 @@ "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "This field is only used when the SortBy value is provided in the\n request.
The maximum number of objects that are returned for this request. If\n MaxResults isn't specified with the SortBy value, the request\n returns 1000 results as the default value for this parameter.
For GetCostCategories, MaxResults has an upper quota of 1000.
The name of the dimension. Each Dimension is available for a different Context. \n\t\t\tFor more information, see Context. \n\t\t\t\n\t\t
The name of the dimension. Each Dimension is available for a different Context. \n\t\t For more information, see Context. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.\n\t\t
The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.
If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
\n- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
\n- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an\n acting reseller for Amazon Web Services in India.
\n- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are\n built on Amazon Web Services by third-party software providers.
\nCACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
\nINSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases.\n Examples are Compute Optimized (for example, C4,\n C5, C6g, and C7g), Memory Optimization\n (for example, R4, R5n, R5b, and\n R6g).
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services\n invoice.
\nLEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
\nLINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nOPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
\nOPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nPURCHASE_TYPE - The reservation type of the purchase that this usage is related to.\n Examples include On-Demand Instances and Standard Reserved Instances.
\nRESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nSAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
\nSERVICE - The Amazon Web Services service such as Amazon DynamoDB.
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nUSAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.
\nREGION - The Amazon Web Services Region.
\nRECORD_TYPE - The different types of charges such as\n Reserved\n Instance (RI) fees, usage costs, tax refunds, and credits.
\nRESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
\nIf you set the context to RESERVATIONS, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nPLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nREGION - The Amazon Web Services Region.
\nSCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
\nTAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nIf you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
\nPAYMENT_OPTION - The payment option for the given Savings Plans (for example, All\n Upfront)
\nREGION - The Amazon Web Services Region.
\nINSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nThe context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.
If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
\n- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
\n- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an\n acting reseller for Amazon Web Services in India.
\n- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are\n built on Amazon Web Services by third-party software providers.
\nCACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
\nINSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases.\n Examples are Compute Optimized (for example, C4,\n C5, C6g, and C7g), Memory Optimization\n (for example, R4, R5n, R5b, and\n R6g).
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services\n invoice.
\nLEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
\nLINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nOPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
\nOPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nPURCHASE_TYPE - The reservation type of the purchase that this usage is related to.\n Examples include On-Demand Instances and Standard Reserved Instances.
\nRESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nSAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
\nSERVICE - The Amazon Web Services service such as Amazon DynamoDB.
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nUSAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.
\nREGION - The Amazon Web Services Region.
\nRECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees, usage\n costs, tax refunds, and credits.
\nRESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
\nIf you set the context to RESERVATIONS, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nPLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nREGION - The Amazon Web Services Region.
\nSCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
\nTAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nIf you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
\nPAYMENT_OPTION - The payment option for the given Savings Plans (for example, All\n Upfront)
\nREGION - The Amazon Web Services Region.
\nINSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nThis field is only used when SortBy is provided in the request. The maximum number of\n objects that are returned for this request. If MaxResults isn't specified with SortBy, the\n request returns 1000 results as the default value for this parameter.
\nFor GetDimensionValues, MaxResults has an upper limit of 1000.
The filters that you used to filter your request. Some dimensions are available only for a specific context.
\n\t\tIf you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
\nINSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
\nLINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nOPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
\nOPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nPURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.
\nSERVICE - The Amazon Web Services service such as Amazon DynamoDB.
\nUSAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.
\nRECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
\nRESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
\nIf you set the context to RESERVATIONS, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid\n values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nPLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nREGION - The Amazon Web Services Region.
\nSCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
\nTAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nIf you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
\nPAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
\nREGION - The Amazon Web Services Region.
\nINSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
\nThe filters that you used to filter your request. Some dimensions are available only for a specific context.
\n\t\tIf you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
\nINSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
\nLINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nOPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
\nOPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nPURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.
\nSERVICE - The Amazon Web Services service such as Amazon DynamoDB.
\nUSAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.
\nRECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
\nRESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. You can opt-in by enabling Hourly and Resource Level Data in Cost Management Console preferences.
If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid\n values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nPLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
\nREGION - The Amazon Web Services Region.
\nSCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
\nTAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nIf you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
\nPAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
\nREGION - The Amazon Web Services Region.
\nINSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
\nThe maximum number of objects that you returned for this request. If more objects are\n available, in the response, Amazon Web Services provides a NextPageToken value that you can use\n in a subsequent call to get the next batch of objects.
" } } @@ -3295,6 +3448,7 @@ "PageSize": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of recommendations that you want returned in a single response object.
" } }, @@ -3371,6 +3525,8 @@ "Granularity": { "target": "com.amazonaws.costexplorer#Granularity", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "DAILY", "smithy.api#documentation": "If GroupBy is set, Granularity can't be set. If Granularity isn't set, \n\t\t\tthe response object doesn't include Granularity, either MONTHLY or DAILY. \n\t\t\tIf both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.
The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.
The maximum number of objects that you returned for this request. If more objects are\n available, in the response, Amazon Web Services provides a NextPageToken value that you can use\n in a subsequent call to get the next batch of objects.
" } } @@ -3467,6 +3623,7 @@ "PageSize": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of recommendations that you want returned in a single response object.
" } }, @@ -3584,7 +3741,7 @@ "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of items to be returned in a response. The default is 20, with a minimum value of 1.
The number of recommendations that you want returned in a single response object.
" } }, @@ -3793,7 +3951,7 @@ "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of items to be returned in a response. The default is 20, with a minimum value of 1.
This field is only used when SortBy is provided in the request. The maximum number of\n objects that are returned for this request. If MaxResults isn't specified with SortBy, the\n request returns 1000 results as the default value for this parameter.
\nFor GetTags, MaxResults has an upper quota of 1000.
The maximum dollar value that's observed for an anomaly.
", "smithy.api#required": {} } @@ -4180,6 +4348,7 @@ "TotalImpact": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The cumulative dollar value that's observed for an anomaly.
" } } @@ -4314,7 +4483,7 @@ "MaxResults": { "target": "com.amazonaws.costexplorer#CostAllocationTagsMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of objects that are returned for this request. By default, the request\n returns 100 results.
" } } @@ -4377,7 +4546,7 @@ "MaxResults": { "target": "com.amazonaws.costexplorer#CostCategoryMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of entries a paginated response contains.
" } } @@ -4444,57 +4613,73 @@ } }, "com.amazonaws.costexplorer#LookbackPeriodInDays": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SEVEN_DAYS", - "name": "SEVEN_DAYS" - }, - { - "value": "THIRTY_DAYS", - "name": "THIRTY_DAYS" - }, - { - "value": "SIXTY_DAYS", - "name": "SIXTY_DAYS" + "type": "enum", + "members": { + "SEVEN_DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVEN_DAYS" + } + }, + "THIRTY_DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRTY_DAYS" + } + }, + "SIXTY_DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIXTY_DAYS" } - ] + } } }, "com.amazonaws.costexplorer#MatchOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "ABSENT", - "name": "ABSENT" - }, - { - "value": "STARTS_WITH", - "name": "STARTS_WITH" - }, - { - "value": "ENDS_WITH", - "name": "ENDS_WITH" - }, - { - "value": "CONTAINS", - "name": "CONTAINS" - }, - { - "value": "CASE_SENSITIVE", - "name": "CASE_SENSITIVE" - }, - { - "value": "CASE_INSENSITIVE", - "name": "CASE_INSENSITIVE" - } - ] + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "ABSENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSENT" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "CASE_SENSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE_SENSITIVE" + } + }, + "CASE_INSENSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE_INSENSITIVE" + } + } } }, "com.amazonaws.costexplorer#MatchOptions": { @@ -4506,44 +4691,57 @@ "com.amazonaws.costexplorer#MaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.costexplorer#Metric": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BLENDED_COST", - "name": "BLENDED_COST" - }, - { - "value": "UNBLENDED_COST", - "name": "UNBLENDED_COST" - }, - { - "value": "AMORTIZED_COST", - "name": "AMORTIZED_COST" - }, - { - "value": "NET_UNBLENDED_COST", - "name": "NET_UNBLENDED_COST" - }, - { - "value": "NET_AMORTIZED_COST", - "name": "NET_AMORTIZED_COST" - }, - { - "value": "USAGE_QUANTITY", - "name": "USAGE_QUANTITY" - }, - { - "value": "NORMALIZED_USAGE_AMOUNT", - "name": "NORMALIZED_USAGE_AMOUNT" - } - ] + "type": "enum", + "members": { + "BLENDED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLENDED_COST" + } + }, + "UNBLENDED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNBLENDED_COST" + } + }, + "AMORTIZED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMORTIZED_COST" + } + }, + "NET_UNBLENDED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NET_UNBLENDED_COST" + } + }, + "NET_AMORTIZED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NET_AMORTIZED_COST" + } + }, + "USAGE_QUANTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_QUANTITY" + } + }, + "NORMALIZED_USAGE_AMOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZED_USAGE_AMOUNT" + } + } } }, "com.amazonaws.costexplorer#MetricAmount": { @@ -4618,29 +4816,31 @@ } }, "com.amazonaws.costexplorer#MonitorDimension": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SERVICE", - "name": "SERVICE" + "type": "enum", + "members": { + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" } - ] + } } }, "com.amazonaws.costexplorer#MonitorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DIMENSIONAL", - "name": "DIMENSIONAL" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" + "type": "enum", + "members": { + "DIMENSIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSIONAL" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" } - ] + } } }, "com.amazonaws.costexplorer#NetRISavings": { @@ -4691,6 +4891,7 @@ "com.amazonaws.costexplorer#NonNegativeInteger": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -4699,56 +4900,67 @@ "com.amazonaws.costexplorer#NullableNonNegativeDouble": { "type": "double", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0.0 } } }, "com.amazonaws.costexplorer#NumericOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUAL", - "name": "EQUAL" - }, - { - "value": "GREATER_THAN_OR_EQUAL", - "name": "GREATER_THAN_OR_EQUAL" - }, - { - "value": "LESS_THAN_OR_EQUAL", - "name": "LESS_THAN_OR_EQUAL" - }, - { - "value": "GREATER_THAN", - "name": "GREATER_THAN" - }, - { - "value": "LESS_THAN", - "name": "LESS_THAN" - }, - { - "value": "BETWEEN", - "name": "BETWEEN" - } - ] + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUAL" + } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL" + } + }, + "LESS_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN_OR_EQUAL" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "BETWEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BETWEEN" + } + } } }, "com.amazonaws.costexplorer#OfferingClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDARD", - "name": "STANDARD" - }, - { - "value": "CONVERTIBLE", - "name": "CONVERTIBLE" + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "CONVERTIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONVERTIBLE" } - ] + } } }, "com.amazonaws.costexplorer#OnDemandCost": { @@ -4764,67 +4976,82 @@ "type": "string" }, "com.amazonaws.costexplorer#PageSize": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.costexplorer#PaymentOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NO_UPFRONT", - "name": "NO_UPFRONT" - }, - { - "value": "PARTIAL_UPFRONT", - "name": "PARTIAL_UPFRONT" - }, - { - "value": "ALL_UPFRONT", - "name": "ALL_UPFRONT" - }, - { - "value": "LIGHT_UTILIZATION", - "name": "LIGHT_UTILIZATION" - }, - { - "value": "MEDIUM_UTILIZATION", - "name": "MEDIUM_UTILIZATION" - }, - { - "value": "HEAVY_UTILIZATION", - "name": "HEAVY_UTILIZATION" - } - ] + "type": "enum", + "members": { + "NO_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_UPFRONT" + } + }, + "PARTIAL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_UPFRONT" + } + }, + "ALL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_UPFRONT" + } + }, + "LIGHT_UTILIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIGHT_UTILIZATION" + } + }, + "MEDIUM_UTILIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM_UTILIZATION" + } + }, + "HEAVY_UTILIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEAVY_UTILIZATION" + } + } } }, "com.amazonaws.costexplorer#PlatformDifference": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HYPERVISOR", - "name": "HYPERVISOR" - }, - { - "value": "NETWORK_INTERFACE", - "name": "NETWORK_INTERFACE" - }, - { - "value": "STORAGE_INTERFACE", - "name": "STORAGE_INTERFACE" - }, - { - "value": "INSTANCE_STORE_AVAILABILITY", - "name": "INSTANCE_STORE_AVAILABILITY" - }, - { - "value": "VIRTUALIZATION_TYPE", - "name": "VIRTUALIZATION_TYPE" - } - ] + "type": "enum", + "members": { + "HYPERVISOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HYPERVISOR" + } + }, + "NETWORK_INTERFACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_INTERFACE" + } + }, + "STORAGE_INTERFACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_INTERFACE" + } + }, + "INSTANCE_STORE_AVAILABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_STORE_AVAILABILITY" + } + }, + "VIRTUALIZATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIRTUALIZATION_TYPE" + } + } } }, "com.amazonaws.costexplorer#PlatformDifferences": { @@ -4836,7 +5063,6 @@ "com.amazonaws.costexplorer#PredictionIntervalLevel": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 51, "max": 99 @@ -4945,12 +5171,14 @@ "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommendation is for a current-generation instance.
" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommended reservation is size flexible.
" } } @@ -4966,18 +5194,20 @@ "type": "string" }, "com.amazonaws.costexplorer#RecommendationTarget": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SAME_INSTANCE_FAMILY", - "name": "SAME_INSTANCE_FAMILY" - }, - { - "value": "CROSS_INSTANCE_FAMILY", - "name": "CROSS_INSTANCE_FAMILY" + "type": "enum", + "members": { + "SAME_INSTANCE_FAMILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAME_INSTANCE_FAMILY" + } + }, + "CROSS_INSTANCE_FAMILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CROSS_INSTANCE_FAMILY" } - ] + } } }, "com.amazonaws.costexplorer#RedshiftInstanceDetails": { @@ -5004,12 +5234,14 @@ "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommendation is for a current-generation instance.
" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the recommended reservation is size flexible.
" } } @@ -5580,6 +5812,7 @@ "Estimated": { "target": "com.amazonaws.costexplorer#Estimated", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the result is estimated.
" } } @@ -5644,6 +5877,8 @@ "RecommendationTarget": { "target": "com.amazonaws.costexplorer#RecommendationTarget", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "SAME_INSTANCE_FAMILY", "smithy.api#documentation": "The option to see recommendations within the same instance family or recommendations\n for instances across other families. The default value is\n SAME_INSTANCE_FAMILY.
The option to consider RI or Savings Plans discount benefits in your savings\n calculation. The default value is TRUE.
The values that are available for a tag.
\nIf Values and Key aren't specified, the ABSENT\n MatchOption is applied to all tags. That is, it's filtered on resources\n with no tags.
If Values is provided and Key isn't specified, the\n ABSENT\n MatchOption is applied to the tag Key only. That is, it's\n filtered on resources without the given tag key.
The values that are available for a tag.
\nIf Values and Key aren't specified, the ABSENT\n MatchOption is applied to all tags. That is, it's filtered on resources\n with no tags.
If Key is provided and Values isn't specified, the\n ABSENT\n MatchOption is applied to the tag Key only. That is, it's\n filtered on resources without the given tag key.
Determines whether this recommendation is the defaulted Amazon Web Services\n recommendation.
" } }, @@ -6681,18 +6936,20 @@ } }, "com.amazonaws.costexplorer#TermInYears": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ONE_YEAR", - "name": "ONE_YEAR" - }, - { - "value": "THREE_YEARS", - "name": "THREE_YEARS" + "type": "enum", + "members": { + "ONE_YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_YEAR" + } + }, + "THREE_YEARS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_YEARS" } - ] + } } }, "com.amazonaws.costexplorer#TerminateRecommendationDetail": { @@ -6753,6 +7010,7 @@ "StartValue": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The lower bound dollar value that's used in the filter.
", "smithy.api#required": {} } @@ -6760,6 +7018,7 @@ "EndValue": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The upper bound dollar value that's used in the filter.
" } } @@ -7105,6 +7364,12 @@ "smithy.api#required": {} } }, + "EffectiveStart": { + "target": "com.amazonaws.costexplorer#ZonedDateTime", + "traits": { + "smithy.api#documentation": "The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.
" + } + }, "RuleVersion": { "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", "traits": { @@ -7141,7 +7406,7 @@ "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "The Cost Category's effective start date.
" + "smithy.api#documentation": "The Cost Category's effective start date. It can only be a billing start date (first day of the month).
" } } } diff --git a/codegen/sdk/aws-models/device-farm.json b/codegen/sdk/aws-models/device-farm.json index 09150f6ec80..f07f0c714d6 100644 --- a/codegen/sdk/aws-models/device-farm.json +++ b/codegen/sdk/aws-models/device-farm.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -80,13 +80,15 @@ "defaultJobTimeoutMinutes": { "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 150, "smithy.api#documentation": "The default number of minutes (at the account level) a test run executes before it times out. The\n default value is 150 minutes.
" } }, "skipAppResign": { "target": "com.amazonaws.devicefarm#SkipAppResign", "traits": { - "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" + "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" } } }, @@ -95,10 +97,7 @@ } }, "com.amazonaws.devicefarm#AccountsCleanup": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.devicefarm#AmazonResourceName": { "type": "string", @@ -123,10 +122,7 @@ } }, "com.amazonaws.devicefarm#AppPackagesCleanup": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.devicefarm#ArgumentException": { "type": "structure", @@ -182,141 +178,199 @@ } }, "com.amazonaws.devicefarm#ArtifactCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SCREENSHOT", - "name": "SCREENSHOT" - }, - { - "value": "FILE", - "name": "FILE" - }, - { - "value": "LOG", - "name": "LOG" + "type": "enum", + "members": { + "SCREENSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCREENSHOT" } - ] + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE" + } + }, + "LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG" + } + } } }, "com.amazonaws.devicefarm#ArtifactType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "SCREENSHOT", - "name": "SCREENSHOT" - }, - { - "value": "DEVICE_LOG", - "name": "DEVICE_LOG" - }, - { - "value": "MESSAGE_LOG", - "name": "MESSAGE_LOG" - }, - { - "value": "VIDEO_LOG", - "name": "VIDEO_LOG" - }, - { - "value": "RESULT_LOG", - "name": "RESULT_LOG" - }, - { - "value": "SERVICE_LOG", - "name": "SERVICE_LOG" - }, - { - "value": "WEBKIT_LOG", - "name": "WEBKIT_LOG" - }, - { - "value": "INSTRUMENTATION_OUTPUT", - "name": "INSTRUMENTATION_OUTPUT" - }, - { - "value": "EXERCISER_MONKEY_OUTPUT", - "name": "EXERCISER_MONKEY_OUTPUT" - }, - { - "value": "CALABASH_JSON_OUTPUT", - "name": "CALABASH_JSON_OUTPUT" - }, - { - "value": "CALABASH_PRETTY_OUTPUT", - "name": "CALABASH_PRETTY_OUTPUT" - }, - { - "value": "CALABASH_STANDARD_OUTPUT", - "name": "CALABASH_STANDARD_OUTPUT" - }, - { - "value": "CALABASH_JAVA_XML_OUTPUT", - "name": "CALABASH_JAVA_XML_OUTPUT" - }, - { - "value": "AUTOMATION_OUTPUT", - "name": "AUTOMATION_OUTPUT" - }, - { - "value": "APPIUM_SERVER_OUTPUT", - "name": "APPIUM_SERVER_OUTPUT" - }, - { - "value": "APPIUM_JAVA_OUTPUT", - "name": "APPIUM_JAVA_OUTPUT" - }, - { - "value": "APPIUM_JAVA_XML_OUTPUT", - "name": "APPIUM_JAVA_XML_OUTPUT" - }, - { - "value": "APPIUM_PYTHON_OUTPUT", - "name": "APPIUM_PYTHON_OUTPUT" - }, - { - "value": "APPIUM_PYTHON_XML_OUTPUT", - "name": "APPIUM_PYTHON_XML_OUTPUT" - }, - { - "value": "EXPLORER_EVENT_LOG", - "name": "EXPLORER_EVENT_LOG" - }, - { - "value": "EXPLORER_SUMMARY_LOG", - "name": "EXPLORER_SUMMARY_LOG" - }, - { - "value": "APPLICATION_CRASH_REPORT", - "name": "APPLICATION_CRASH_REPORT" - }, - { - "value": "XCTEST_LOG", - "name": "XCTEST_LOG" - }, - { - "value": "VIDEO", - "name": "VIDEO" - }, - { - "value": "CUSTOMER_ARTIFACT", - "name": "CUSTOMER_ARTIFACT" - }, - { - "value": "CUSTOMER_ARTIFACT_LOG", - "name": "CUSTOMER_ARTIFACT_LOG" - }, - { - "value": "TESTSPEC_OUTPUT", - "name": "TESTSPEC_OUTPUT" - } - ] + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "SCREENSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCREENSHOT" + } + }, + "DEVICE_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVICE_LOG" + } + }, + "MESSAGE_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MESSAGE_LOG" + } + }, + "VIDEO_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO_LOG" + } + }, + "RESULT_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESULT_LOG" + } + }, + "SERVICE_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_LOG" + } + }, + "WEBKIT_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBKIT_LOG" + } + }, + "INSTRUMENTATION_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTRUMENTATION_OUTPUT" + } + }, + "EXERCISER_MONKEY_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXERCISER_MONKEY_OUTPUT" + } + }, + "CALABASH_JSON_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALABASH_JSON_OUTPUT" + } + }, + "CALABASH_PRETTY_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALABASH_PRETTY_OUTPUT" + } + }, + "CALABASH_STANDARD_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALABASH_STANDARD_OUTPUT" + } + }, + "CALABASH_JAVA_XML_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALABASH_JAVA_XML_OUTPUT" + } + }, + "AUTOMATION_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATION_OUTPUT" + } + }, + "APPIUM_SERVER_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_SERVER_OUTPUT" + } + }, + "APPIUM_JAVA_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_OUTPUT" + } + }, + "APPIUM_JAVA_XML_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_XML_OUTPUT" + } + }, + "APPIUM_PYTHON_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_PYTHON_OUTPUT" + } + }, + "APPIUM_PYTHON_XML_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_PYTHON_XML_OUTPUT" + } + }, + "EXPLORER_EVENT_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLORER_EVENT_LOG" + } + }, + "EXPLORER_SUMMARY_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLORER_SUMMARY_LOG" + } + }, + "APPLICATION_CRASH_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_CRASH_REPORT" + } + }, + "XCTEST_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XCTEST_LOG" + } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + }, + "CUSTOMER_ARTIFACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_ARTIFACT" + } + }, + "CUSTOMER_ARTIFACT_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_ARTIFACT_LOG" + } + }, + "TESTSPEC_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TESTSPEC_OUTPUT" + } + } } }, "com.amazonaws.devicefarm#Artifacts": { @@ -326,25 +380,24 @@ } }, "com.amazonaws.devicefarm#BillingMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "METERED", - "name": "METERED" - }, - { - "value": "UNMETERED", - "name": "UNMETERED" + "type": "enum", + "members": { + "METERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METERED" + } + }, + "UNMETERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNMETERED" } - ] + } } }, "com.amazonaws.devicefarm#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.devicefarm#CPU": { "type": "structure", @@ -579,6 +632,8 @@ "packageCleanup": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "When set to true, Device Farm removes app packages after a test run. The default value is\n false for private devices.
When set to true, Device Farm reboots the instance after a test run. The default value is\n true.
Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.
" } }, "downlinkLossPercent": { "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Proportion of received packets that fail to arrive from 0 to 100 percent.
" } } @@ -767,6 +826,12 @@ "traits": { "smithy.api#documentation": "Sets the execution timeout value (in minutes) for a project. All test runs in this project use the\n specified execution timeout value unless overridden when scheduling a run.
" } + }, + "vpcConfig": { + "target": "com.amazonaws.devicefarm#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a project.
" + } } }, "traits": { @@ -819,6 +884,8 @@ "billingMethod": { "target": "com.amazonaws.devicefarm#BillingMethod", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "METERED", "smithy.api#documentation": "The billing method for the remote access session.
" } }, @@ -859,13 +926,13 @@ "sshPublicKey": { "target": "com.amazonaws.devicefarm#SshPublicKey", "traits": { - "smithy.api#documentation": "Ignored. The public key of the ssh key pair you want to use for connecting to remote\n devices in your remote debugging session. This key is required only if remoteDebugEnabled is\n set to true.
Remote debugging is no\n longer supported.
" + "smithy.api#documentation": "Ignored. The public key of the ssh key pair you want to use for connecting to remote\n devices in your remote debugging session. This key is required only if remoteDebugEnabled is\n set to true.
Remote debugging is no\n longer supported.
" } }, "remoteDebugEnabled": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "Set to true if you want to access devices remotely for debugging in\n your remote access session.
Remote debugging is no\n longer supported.
" + "smithy.api#documentation": "Set to true if you want to access devices remotely for debugging in\n your remote access session.
Remote debugging is no\n longer supported.
" } }, "remoteRecordEnabled": { @@ -889,7 +956,7 @@ "clientId": { "target": "com.amazonaws.devicefarm#ClientId", "traits": { - "smithy.api#documentation": "Unique identifier for the client. If you want access to multiple devices on the same client, you should\n pass the same clientId value in each call to CreateRemoteAccessSession. This\n identifier is required only if remoteDebugEnabled is set to true.
Remote debugging is no\n longer supported.
" + "smithy.api#documentation": "Unique identifier for the client. If you want access to multiple devices on the same client, you should\n pass the same clientId value in each call to CreateRemoteAccessSession. This\n identifier is required only if remoteDebugEnabled is set to true.
Remote debugging is no\n longer supported.
" } }, "configuration": { @@ -907,7 +974,7 @@ "skipAppResign": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?\n
" + "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?\n
" } } }, @@ -1188,14 +1255,14 @@ } }, "com.amazonaws.devicefarm#CurrencyCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USD", - "name": "USD" + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" } - ] + } } }, "com.amazonaws.devicefarm#CustomerArtifactPaths": { @@ -1737,7 +1804,7 @@ "remoteDebugEnabled": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "This flag is set to true if remote debugging is enabled for the\n device.
Remote debugging is no\n longer supported.
" + "smithy.api#documentation": "This flag is set to true if remote debugging is enabled for the\n device.
Remote debugging is no\n longer supported.
" } }, "fleetType": { @@ -1770,85 +1837,115 @@ } }, "com.amazonaws.devicefarm#DeviceAttribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARN", - "name": "ARN" - }, - { - "value": "PLATFORM", - "name": "PLATFORM" - }, - { - "value": "FORM_FACTOR", - "name": "FORM_FACTOR" - }, - { - "value": "MANUFACTURER", - "name": "MANUFACTURER" - }, - { - "value": "REMOTE_ACCESS_ENABLED", - "name": "REMOTE_ACCESS_ENABLED" - }, - { - "value": "REMOTE_DEBUG_ENABLED", - "name": "REMOTE_DEBUG_ENABLED" - }, - { - "value": "APPIUM_VERSION", - "name": "APPIUM_VERSION" - }, - { - "value": "INSTANCE_ARN", - "name": "INSTANCE_ARN" - }, - { - "value": "INSTANCE_LABELS", - "name": "INSTANCE_LABELS" - }, - { - "value": "FLEET_TYPE", - "name": "FLEET_TYPE" - }, - { - "value": "OS_VERSION", - "name": "OS_VERSION" - }, - { - "value": "MODEL", - "name": "MODEL" - }, - { - "value": "AVAILABILITY", - "name": "AVAILABILITY" - } - ] + "type": "enum", + "members": { + "ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARN" + } + }, + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM" + } + }, + "FORM_FACTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORM_FACTOR" + } + }, + "MANUFACTURER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUFACTURER" + } + }, + "REMOTE_ACCESS_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOTE_ACCESS_ENABLED" + } + }, + "REMOTE_DEBUG_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOTE_DEBUG_ENABLED" + } + }, + "APPIUM_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_VERSION" + } + }, + "INSTANCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_ARN" + } + }, + "INSTANCE_LABELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_LABELS" + } + }, + "FLEET_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_TYPE" + } + }, + "OS_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OS_VERSION" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL" + } + }, + "AVAILABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABILITY" + } + } } }, "com.amazonaws.devicefarm#DeviceAvailability": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TEMPORARY_NOT_AVAILABLE", - "name": "TEMPORARY_NOT_AVAILABLE" - }, - { - "value": "BUSY", - "name": "BUSY" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "HIGHLY_AVAILABLE", - "name": "HIGHLY_AVAILABLE" - } - ] + "type": "enum", + "members": { + "TEMPORARY_NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPORARY_NOT_AVAILABLE" + } + }, + "BUSY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUSY" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "HIGHLY_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGHLY_AVAILABLE" + } + } } }, "com.amazonaws.devicefarm#DeviceFarmArn": { @@ -2122,7 +2219,7 @@ "attribute": { "target": "com.amazonaws.devicefarm#DeviceFilterAttribute", "traits": { - "smithy.api#documentation": "The aspect of a device such as platform or model used as the selection criteria in a\n device filter.
\nThe supported operators for each attribute are provided in the following list.
\nThe Amazon Resource Name (ARN) of the device (for example,\n arn:aws:devicefarm:us-west-2::device:12345Example).
Supported operators: EQUALS, IN, NOT_IN\n
The device platform. Valid values are ANDROID or IOS.
\nSupported operators: EQUALS\n
The operating system version (for example, 10.3.2).
\nSupported operators: EQUALS, GREATER_THAN,\n GREATER_THAN_OR_EQUALS, IN,\n LESS_THAN, LESS_THAN_OR_EQUALS,\n NOT_IN\n
The device model (for example, iPad 5th Gen).
\nSupported operators: CONTAINS, EQUALS,\n IN, NOT_IN\n
The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
\nSupported operators: EQUALS\n
The device form factor. Valid values are PHONE or TABLET.
\nSupported operators: EQUALS\n
The device manufacturer (for example, Apple).
\nSupported operators: EQUALS, IN,\n NOT_IN\n
Whether the device is enabled for remote access. Valid values are TRUE or\n FALSE.
\nSupported operators: EQUALS\n
Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
\nSupported operators: EQUALS\n
Because remote debugging is no longer\n supported, this filter is ignored.
\nThe Amazon Resource Name (ARN) of the device instance.
\nSupported operators: EQUALS, IN,\n NOT_IN\n
The label of the device instance.
\nSupported operators: CONTAINS\n
The fleet type. Valid values are PUBLIC or PRIVATE.
\nSupported operators: EQUALS\n
The aspect of a device such as platform or model used as the selection criteria in a\n device filter.
\nThe supported operators for each attribute are provided in the following list.
\nThe Amazon Resource Name (ARN) of the device (for example,\n arn:aws:devicefarm:us-west-2::device:12345Example).
Supported operators: EQUALS, IN, NOT_IN\n
The device platform. Valid values are ANDROID or IOS.
\nSupported operators: EQUALS\n
The operating system version (for example, 10.3.2).
\nSupported operators: EQUALS, GREATER_THAN,\n GREATER_THAN_OR_EQUALS, IN,\n LESS_THAN, LESS_THAN_OR_EQUALS,\n NOT_IN\n
The device model (for example, iPad 5th Gen).
\nSupported operators: CONTAINS, EQUALS,\n IN, NOT_IN\n
The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
\nSupported operators: EQUALS\n
The device form factor. Valid values are PHONE or TABLET.
\nSupported operators: EQUALS\n
The device manufacturer (for example, Apple).
\nSupported operators: EQUALS, IN,\n NOT_IN\n
Whether the device is enabled for remote access. Valid values are TRUE or\n FALSE.
\nSupported operators: EQUALS\n
Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
\nSupported operators: EQUALS\n
Because remote debugging is no\n longer supported, this filter is ignored.
\nThe Amazon Resource Name (ARN) of the device instance.
\nSupported operators: EQUALS, IN,\n NOT_IN\n
The label of the device instance.
\nSupported operators: CONTAINS\n
The fleet type. Valid values are PUBLIC or PRIVATE.
\nSupported operators: EQUALS\n
Set to true to enable video capture. Otherwise, set to false. The default is true.
" } }, "skipAppResign": { "target": "com.amazonaws.devicefarm#SkipAppResign", "traits": { - "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" + "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" } } }, @@ -2523,96 +2647,126 @@ } }, "com.amazonaws.devicefarm#ExecutionResult": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "PASSED", - "name": "PASSED" - }, - { - "value": "WARNED", - "name": "WARNED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "SKIPPED", - "name": "SKIPPED" - }, - { - "value": "ERRORED", - "name": "ERRORED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.devicefarm#ExecutionResultCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PARSING_FAILED", - "name": "PARSING_FAILED" - }, - { - "value": "VPC_ENDPOINT_SETUP_FAILED", - "name": "VPC_ENDPOINT_SETUP_FAILED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] - } - }, - "com.amazonaws.devicefarm#ExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "PENDING_CONCURRENCY", - "name": "PENDING_CONCURRNECY" - }, - { - "value": "PENDING_DEVICE", - "name": "PENDING_DEVICE" - }, - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "SCHEDULING", - "name": "SCHEDULING" - }, - { - "value": "PREPARING", - "name": "PREPARING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - } - ] + }, + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "WARNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + }, + "ERRORED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERRORED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.devicefarm#ExecutionResultCode": { + "type": "enum", + "members": { + "PARSING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARSING_FAILED" + } + }, + "VPC_ENDPOINT_SETUP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_ENDPOINT_SETUP_FAILED" + } + } + } + }, + "com.amazonaws.devicefarm#ExecutionStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PENDING_CONCURRNECY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CONCURRENCY" + } + }, + "PENDING_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DEVICE" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "SCHEDULING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULING" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + } } }, "com.amazonaws.devicefarm#Filter": { @@ -3750,6 +3904,8 @@ "packageCleanup": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "When set to true, Device Farm removes app packages after a test run. The default value is\n false for private devices.
When set to true, Device Farm reboots the instance after a test run. The default value is\n true.
Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.
" } }, "downlinkLossPercent": { "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Proportion of received packets that fail to arrive from 0 to 100 percent.
" } } @@ -5835,18 +5997,20 @@ } }, "com.amazonaws.devicefarm#NetworkProfileType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CURATED", - "name": "CURATED" - }, - { - "value": "PRIVATE", - "name": "PRIVATE" + "type": "enum", + "members": { + "CURATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURATED" + } + }, + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATE" } - ] + } } }, "com.amazonaws.devicefarm#NetworkProfiles": { @@ -6055,22 +6219,26 @@ } }, "com.amazonaws.devicefarm#OfferingTransactionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PURCHASE", - "name": "PURCHASE" - }, - { - "value": "RENEW", - "name": "RENEW" - }, - { - "value": "SYSTEM", - "name": "SYSTEM" + "type": "enum", + "members": { + "PURCHASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PURCHASE" } - ] + }, + "RENEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RENEW" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + } } }, "com.amazonaws.devicefarm#OfferingTransactions": { @@ -6080,14 +6248,14 @@ } }, "com.amazonaws.devicefarm#OfferingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RECURRING", - "name": "RECURRING" + "type": "enum", + "members": { + "RECURRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECURRING" } - ] + } } }, "com.amazonaws.devicefarm#Offerings": { @@ -6114,6 +6282,7 @@ "com.amazonaws.devicefarm#PercentInteger": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 @@ -6214,6 +6383,8 @@ "defaultJobTimeoutMinutes": { "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 150, "smithy.api#documentation": "The default number of minutes (at the project level) a test run executes before it times out. The\n default value is 150 minutes.
" } }, @@ -6222,6 +6393,12 @@ "traits": { "smithy.api#documentation": "When the project was created.
" } + }, + "vpcConfig": { + "target": "com.amazonaws.devicefarm#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a project.
" + } } }, "traits": { @@ -6367,14 +6544,14 @@ } }, "com.amazonaws.devicefarm#RecurringChargeFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MONTHLY", - "name": "MONTHLY" + "type": "enum", + "members": { + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" } - ] + } } }, "com.amazonaws.devicefarm#RecurringCharges": { @@ -6449,7 +6626,7 @@ "remoteDebugEnabled": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "This flag is set to true if remote debugging is enabled for the remote\n access session.
Remote debugging is no\n longer supported.
" + "smithy.api#documentation": "This flag is set to true if remote debugging is enabled for the remote\n access session.
Remote debugging is no\n longer supported.
" } }, "remoteRecordEnabled": { @@ -6467,18 +6644,20 @@ "hostAddress": { "target": "com.amazonaws.devicefarm#HostAddress", "traits": { - "smithy.api#documentation": "IP address of the EC2 host where you need to connect to remotely debug devices.\n Only returned if remote debugging is enabled for the remote access session.
\nRemote debugging is no\n longer supported.
" + "smithy.api#documentation": "IP address of the EC2 host where you need to connect to remotely debug devices.\n Only returned if remote debugging is enabled for the remote access session.
\nRemote debugging is no\n longer supported.
" } }, "clientId": { "target": "com.amazonaws.devicefarm#ClientId", "traits": { - "smithy.api#documentation": "Unique identifier of your client for the remote access session. Only returned if\n remote debugging is enabled for the remote access session.
\nRemote debugging is no\n longer supported.
" + "smithy.api#documentation": "Unique identifier of your client for the remote access session. Only returned if\n remote debugging is enabled for the remote access session.
\nRemote debugging is no\n longer supported.
" } }, "billingMethod": { "target": "com.amazonaws.devicefarm#BillingMethod", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "METERED", "smithy.api#documentation": "The billing method of the remote access session. Possible values include METERED or\n UNMETERED. For more information about metered devices, see AWS Device Farm\n terminology.
Unique device identifier for the remote device. Only returned if remote debugging\n is enabled for the remote access session.
\nRemote debugging is no\n longer supported.
" + "smithy.api#documentation": "Unique device identifier for the remote device. Only returned if remote debugging\n is enabled for the remote access session.
\nRemote debugging is no\n longer supported.
" } }, "interactionMode": { @@ -6509,7 +6688,13 @@ "skipAppResign": { "target": "com.amazonaws.devicefarm#SkipAppResign", "traits": { - "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" + "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" + } + }, + "vpcConfig": { + "target": "com.amazonaws.devicefarm#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a project.
" } } }, @@ -6644,7 +6829,7 @@ "attribute": { "target": "com.amazonaws.devicefarm#DeviceAttribute", "traits": { - "smithy.api#documentation": "The rule's stringified attribute. For example, specify the value as\n \"\\\"abc\\\"\".
The supported operators for each attribute are provided in the following\n list.
\nThe Appium version for the test.
\nSupported operators: CONTAINS\n
The Amazon Resource Name (ARN) of the device (for example,\n arn:aws:devicefarm:us-west-2::device:12345Example.
Supported operators: EQUALS,\n IN, NOT_IN\n
The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
\nSupported operators: EQUALS\n
The fleet type. Valid values are PUBLIC or PRIVATE.
\nSupported operators: EQUALS\n
The device form factor. Valid values are PHONE or TABLET.
\nSupported operators: EQUALS,\n IN, NOT_IN\n
The Amazon Resource Name (ARN) of the device instance.
\nSupported operators: IN,\n NOT_IN\n
The label of the device instance.
\nSupported operators: CONTAINS\n
The device manufacturer (for example, Apple).
\nSupported operators: EQUALS,\n IN, NOT_IN\n
The device model, such as Apple iPad Air 2 or Google Pixel.
\nSupported operators: CONTAINS,\n EQUALS, IN, NOT_IN\n
The operating system version (for example, 10.3.2).
\nSupported operators: EQUALS,\n GREATER_THAN, GREATER_THAN_OR_EQUALS,\n IN, LESS_THAN,\n LESS_THAN_OR_EQUALS, NOT_IN\n
The device platform. Valid values are ANDROID or IOS.
\nSupported operators: EQUALS,\n IN, NOT_IN\n
Whether the device is enabled for remote access. Valid values are TRUE\n or FALSE.
\nSupported operators: EQUALS\n
Whether the device is enabled for remote debugging. Valid values are\n TRUE or FALSE.
\nSupported operators: EQUALS\n
Because remote debugging is no longer\n supported, this filter is ignored.
\nThe rule's stringified attribute. For example, specify the value as\n \"\\\"abc\\\"\".
The supported operators for each attribute are provided in the following\n list.
\nThe Appium version for the test.
\nSupported operators: CONTAINS\n
The Amazon Resource Name (ARN) of the device (for example,\n arn:aws:devicefarm:us-west-2::device:12345Example.
Supported operators: EQUALS,\n IN, NOT_IN\n
The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
\nSupported operators: EQUALS\n
The fleet type. Valid values are PUBLIC or PRIVATE.
\nSupported operators: EQUALS\n
The device form factor. Valid values are PHONE or TABLET.
\nSupported operators: EQUALS,\n IN, NOT_IN\n
The Amazon Resource Name (ARN) of the device instance.
\nSupported operators: IN,\n NOT_IN\n
The label of the device instance.
\nSupported operators: CONTAINS\n
The device manufacturer (for example, Apple).
\nSupported operators: EQUALS,\n IN, NOT_IN\n
The device model, such as Apple iPad Air 2 or Google Pixel.
\nSupported operators: CONTAINS,\n EQUALS, IN, NOT_IN\n
The operating system version (for example, 10.3.2).
\nSupported operators: EQUALS,\n GREATER_THAN, GREATER_THAN_OR_EQUALS,\n IN, LESS_THAN,\n LESS_THAN_OR_EQUALS, NOT_IN\n
The device platform. Valid values are ANDROID or IOS.
\nSupported operators: EQUALS,\n IN, NOT_IN\n
Whether the device is enabled for remote access. Valid values are TRUE\n or FALSE.
\nSupported operators: EQUALS\n
Whether the device is enabled for remote debugging. Valid values are\n TRUE or FALSE.
\nSupported operators: EQUALS\n
Because remote debugging is no\n longer supported, this filter is ignored.
\nSpecifies the billing method for a test run: metered or\n unmetered. If the parameter is not specified, the default value is\n metered.
If you have unmetered device slots, you must set this to unmetered to use them.\n Otherwise, the run is counted toward metered device minutes.
When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" + "smithy.api#documentation": "When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.
" } }, "testSpecArn": { @@ -6897,6 +7098,12 @@ "traits": { "smithy.api#documentation": "The results of a device filter used to select the devices for a test run.
" } + }, + "vpcConfig": { + "target": "com.amazonaws.devicefarm#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a project.
" + } } }, "traits": { @@ -6936,78 +7143,110 @@ } }, "com.amazonaws.devicefarm#SampleType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CPU", - "name": "CPU" - }, - { - "value": "MEMORY", - "name": "MEMORY" - }, - { - "value": "THREADS", - "name": "THREADS" - }, - { - "value": "RX_RATE", - "name": "RX_RATE" - }, - { - "value": "TX_RATE", - "name": "TX_RATE" - }, - { - "value": "RX", - "name": "RX" - }, - { - "value": "TX", - "name": "TX" - }, - { - "value": "NATIVE_FRAMES", - "name": "NATIVE_FRAMES" - }, - { - "value": "NATIVE_FPS", - "name": "NATIVE_FPS" - }, - { - "value": "NATIVE_MIN_DRAWTIME", - "name": "NATIVE_MIN_DRAWTIME" - }, - { - "value": "NATIVE_AVG_DRAWTIME", - "name": "NATIVE_AVG_DRAWTIME" - }, - { - "value": "NATIVE_MAX_DRAWTIME", - "name": "NATIVE_MAX_DRAWTIME" - }, - { - "value": "OPENGL_FRAMES", - "name": "OPENGL_FRAMES" - }, - { - "value": "OPENGL_FPS", - "name": "OPENGL_FPS" - }, - { - "value": "OPENGL_MIN_DRAWTIME", - "name": "OPENGL_MIN_DRAWTIME" - }, - { - "value": "OPENGL_AVG_DRAWTIME", - "name": "OPENGL_AVG_DRAWTIME" - }, - { - "value": "OPENGL_MAX_DRAWTIME", - "name": "OPENGL_MAX_DRAWTIME" - } - ] + "type": "enum", + "members": { + "CPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU" + } + }, + "MEMORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMORY" + } + }, + "THREADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREADS" + } + }, + "RX_RATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RX_RATE" + } + }, + "TX_RATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TX_RATE" + } + }, + "RX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RX" + } + }, + "TX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TX" + } + }, + "NATIVE_FRAMES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_FRAMES" + } + }, + "NATIVE_FPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_FPS" + } + }, + "NATIVE_MIN_DRAWTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_MIN_DRAWTIME" + } + }, + "NATIVE_AVG_DRAWTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_AVG_DRAWTIME" + } + }, + "NATIVE_MAX_DRAWTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_MAX_DRAWTIME" + } + }, + "OPENGL_FRAMES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENGL_FRAMES" + } + }, + "OPENGL_FPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENGL_FPS" + } + }, + "OPENGL_MIN_DRAWTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENGL_MIN_DRAWTIME" + } + }, + "OPENGL_AVG_DRAWTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENGL_AVG_DRAWTIME" + } + }, + "OPENGL_MAX_DRAWTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENGL_MAX_DRAWTIME" + } + } } }, "com.amazonaws.devicefarm#Samples": { @@ -7099,6 +7338,8 @@ "billingMethod": { "target": "com.amazonaws.devicefarm#BillingMethod", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "METERED", "smithy.api#documentation": "Specifies the billing method for a test run: metered or\n unmetered. If the parameter is not specified, the default value is\n metered.
If you have purchased unmetered device slots, you must set this parameter to unmetered to\n make use of them. Otherwise, your run counts against your metered time.
Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an\n example of the JSON request syntax, see ScheduleRun.
" } }, + "com.amazonaws.devicefarm#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,}$" + } + }, "com.amazonaws.devicefarm#SecurityGroupIds": { "type": "list", "member": { @@ -7271,10 +7522,7 @@ } }, "com.amazonaws.devicefarm#SkipAppResign": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.devicefarm#SshPublicKey": { "type": "string", @@ -7447,6 +7695,16 @@ "com.amazonaws.devicefarm#String": { "type": "string" }, + "com.amazonaws.devicefarm#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^subnet-[0-9a-fA-F]{8,}$" + } + }, "com.amazonaws.devicefarm#SubnetIds": { "type": "list", "member": { @@ -7920,37 +8178,43 @@ } }, "com.amazonaws.devicefarm#TestGridSessionArtifactCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VIDEO", - "name": "VIDEO" - }, - { - "value": "LOG", - "name": "LOG" + "type": "enum", + "members": { + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" } - ] + }, + "LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG" + } + } } }, "com.amazonaws.devicefarm#TestGridSessionArtifactType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "VIDEO", - "name": "VIDEO" - }, - { - "value": "SELENIUM_LOG", - "name": "SELENIUM_LOG" + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" } - ] + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + }, + "SELENIUM_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELENIUM_LOG" + } + } } }, "com.amazonaws.devicefarm#TestGridSessionArtifacts": { @@ -7960,22 +8224,26 @@ } }, "com.amazonaws.devicefarm#TestGridSessionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "CLOSED", - "name": "CLOSED" - }, - { - "value": "ERRORED", - "name": "ERRORED" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + }, + "ERRORED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERRORED" } - ] + } } }, "com.amazonaws.devicefarm#TestGridSessions": { @@ -7987,7 +8255,6 @@ "com.amazonaws.devicefarm#TestGridUrlExpiresInSecondsInput": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 86400 @@ -8033,94 +8300,134 @@ } }, "com.amazonaws.devicefarm#TestType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BUILTIN_FUZZ", - "name": "BUILTIN_FUZZ" - }, - { - "value": "BUILTIN_EXPLORER", - "name": "BUILTIN_EXPLORER" - }, - { - "value": "WEB_PERFORMANCE_PROFILE", - "name": "WEB_PERFORMANCE_PROFILE" - }, - { - "value": "APPIUM_JAVA_JUNIT", - "name": "APPIUM_JAVA_JUNIT" - }, - { - "value": "APPIUM_JAVA_TESTNG", - "name": "APPIUM_JAVA_TESTNG" - }, - { - "value": "APPIUM_PYTHON", - "name": "APPIUM_PYTHON" - }, - { - "value": "APPIUM_NODE", - "name": "APPIUM_NODE" - }, - { - "value": "APPIUM_RUBY", - "name": "APPIUM_RUBY" - }, - { - "value": "APPIUM_WEB_JAVA_JUNIT", - "name": "APPIUM_WEB_JAVA_JUNIT" - }, - { - "value": "APPIUM_WEB_JAVA_TESTNG", - "name": "APPIUM_WEB_JAVA_TESTNG" - }, - { - "value": "APPIUM_WEB_PYTHON", - "name": "APPIUM_WEB_PYTHON" - }, - { - "value": "APPIUM_WEB_NODE", - "name": "APPIUM_WEB_NODE" - }, - { - "value": "APPIUM_WEB_RUBY", - "name": "APPIUM_WEB_RUBY" - }, - { - "value": "CALABASH", - "name": "CALABASH" - }, - { - "value": "INSTRUMENTATION", - "name": "INSTRUMENTATION" - }, - { - "value": "UIAUTOMATION", - "name": "UIAUTOMATION" - }, - { - "value": "UIAUTOMATOR", - "name": "UIAUTOMATOR" - }, - { - "value": "XCTEST", - "name": "XCTEST" - }, - { - "value": "XCTEST_UI", - "name": "XCTEST_UI" - }, - { - "value": "REMOTE_ACCESS_RECORD", - "name": "REMOTE_ACCESS_RECORD" - }, - { - "value": "REMOTE_ACCESS_REPLAY", - "name": "REMOTE_ACCESS_REPLAY" - } - ] + "type": "enum", + "members": { + "BUILTIN_FUZZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILTIN_FUZZ" + } + }, + "BUILTIN_EXPLORER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILTIN_EXPLORER" + } + }, + "WEB_PERFORMANCE_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_PERFORMANCE_PROFILE" + } + }, + "APPIUM_JAVA_JUNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_JUNIT" + } + }, + "APPIUM_JAVA_TESTNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_TESTNG" + } + }, + "APPIUM_PYTHON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_PYTHON" + } + }, + "APPIUM_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_NODE" + } + }, + "APPIUM_RUBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_RUBY" + } + }, + "APPIUM_WEB_JAVA_JUNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_JAVA_JUNIT" + } + }, + "APPIUM_WEB_JAVA_TESTNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_JAVA_TESTNG" + } + }, + "APPIUM_WEB_PYTHON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_PYTHON" + } + }, + "APPIUM_WEB_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_NODE" + } + }, + "APPIUM_WEB_RUBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_RUBY" + } + }, + "CALABASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALABASH" + } + }, + "INSTRUMENTATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTRUMENTATION" + } + }, + "UIAUTOMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UIAUTOMATION" + } + }, + "UIAUTOMATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UIAUTOMATOR" + } + }, + "XCTEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XCTEST" + } + }, + "XCTEST_UI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XCTEST_UI" + } + }, + "REMOTE_ACCESS_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOTE_ACCESS_RECORD" + } + }, + "REMOTE_ACCESS_REPLAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOTE_ACCESS_REPLAY" + } + } } }, "com.amazonaws.devicefarm#Tests": { @@ -8460,6 +8767,8 @@ "packageCleanup": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "The updated choice for whether you want to specify package cleanup. The default value\n is false for private devices.
Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.
" } }, "downlinkLossPercent": { "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Proportion of received packets that fail to arrive from 0 to 100 percent.
" } } @@ -8650,6 +8961,12 @@ "traits": { "smithy.api#documentation": "The number of minutes a test run in the project executes before it times out.
" } + }, + "vpcConfig": { + "target": "com.amazonaws.devicefarm#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a project.
" + } } }, "traits": { @@ -8946,176 +9263,246 @@ } }, "com.amazonaws.devicefarm#UploadCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CURATED", - "name": "CURATED" - }, - { - "value": "PRIVATE", - "name": "PRIVATE" + "type": "enum", + "members": { + "CURATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURATED" } - ] + }, + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATE" + } + } } }, "com.amazonaws.devicefarm#UploadStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INITIALIZED", - "name": "INITIALIZED" - }, - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "INITIALIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.devicefarm#UploadType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ANDROID_APP", - "name": "ANDROID_APP" - }, - { - "value": "IOS_APP", - "name": "IOS_APP" - }, - { - "value": "WEB_APP", - "name": "WEB_APP" - }, - { - "value": "EXTERNAL_DATA", - "name": "EXTERNAL_DATA" - }, - { - "value": "APPIUM_JAVA_JUNIT_TEST_PACKAGE", - "name": "APPIUM_JAVA_JUNIT_TEST_PACKAGE" - }, - { - "value": "APPIUM_JAVA_TESTNG_TEST_PACKAGE", - "name": "APPIUM_JAVA_TESTNG_TEST_PACKAGE" - }, - { - "value": "APPIUM_PYTHON_TEST_PACKAGE", - "name": "APPIUM_PYTHON_TEST_PACKAGE" - }, - { - "value": "APPIUM_NODE_TEST_PACKAGE", - "name": "APPIUM_NODE_TEST_PACKAGE" - }, - { - "value": "APPIUM_RUBY_TEST_PACKAGE", - "name": "APPIUM_RUBY_TEST_PACKAGE" - }, - { - "value": "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE", - "name": "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE" - }, - { - "value": "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE", - "name": "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE" - }, - { - "value": "APPIUM_WEB_PYTHON_TEST_PACKAGE", - "name": "APPIUM_WEB_PYTHON_TEST_PACKAGE" - }, - { - "value": "APPIUM_WEB_NODE_TEST_PACKAGE", - "name": "APPIUM_WEB_NODE_TEST_PACKAGE" - }, - { - "value": "APPIUM_WEB_RUBY_TEST_PACKAGE", - "name": "APPIUM_WEB_RUBY_TEST_PACKAGE" - }, - { - "value": "CALABASH_TEST_PACKAGE", - "name": "CALABASH_TEST_PACKAGE" - }, - { - "value": "INSTRUMENTATION_TEST_PACKAGE", - "name": "INSTRUMENTATION_TEST_PACKAGE" - }, - { - "value": "UIAUTOMATION_TEST_PACKAGE", - "name": "UIAUTOMATION_TEST_PACKAGE" - }, - { - "value": "UIAUTOMATOR_TEST_PACKAGE", - "name": "UIAUTOMATOR_TEST_PACKAGE" - }, - { - "value": "XCTEST_TEST_PACKAGE", - "name": "XCTEST_TEST_PACKAGE" - }, - { - "value": "XCTEST_UI_TEST_PACKAGE", - "name": "XCTEST_UI_TEST_PACKAGE" - }, - { - "value": "APPIUM_JAVA_JUNIT_TEST_SPEC", - "name": "APPIUM_JAVA_JUNIT_TEST_SPEC" - }, - { - "value": "APPIUM_JAVA_TESTNG_TEST_SPEC", - "name": "APPIUM_JAVA_TESTNG_TEST_SPEC" - }, - { - "value": "APPIUM_PYTHON_TEST_SPEC", - "name": "APPIUM_PYTHON_TEST_SPEC" - }, - { - "value": "APPIUM_NODE_TEST_SPEC", - "name": "APPIUM_NODE_TEST_SPEC" - }, - { - "value": "APPIUM_RUBY_TEST_SPEC", - "name": "APPIUM_RUBY_TEST_SPEC" - }, - { - "value": "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC", - "name": "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC" - }, - { - "value": "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC", - "name": "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC" - }, - { - "value": "APPIUM_WEB_PYTHON_TEST_SPEC", - "name": "APPIUM_WEB_PYTHON_TEST_SPEC" - }, - { - "value": "APPIUM_WEB_NODE_TEST_SPEC", - "name": "APPIUM_WEB_NODE_TEST_SPEC" - }, - { - "value": "APPIUM_WEB_RUBY_TEST_SPEC", - "name": "APPIUM_WEB_RUBY_TEST_SPEC" - }, - { - "value": "INSTRUMENTATION_TEST_SPEC", - "name": "INSTRUMENTATION_TEST_SPEC" - }, - { - "value": "XCTEST_UI_TEST_SPEC", - "name": "XCTEST_UI_TEST_SPEC" - } - ] + "type": "enum", + "members": { + "ANDROID_APP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANDROID_APP" + } + }, + "IOS_APP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOS_APP" + } + }, + "WEB_APP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_APP" + } + }, + "EXTERNAL_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_DATA" + } + }, + "APPIUM_JAVA_JUNIT_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_JUNIT_TEST_PACKAGE" + } + }, + "APPIUM_JAVA_TESTNG_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_TESTNG_TEST_PACKAGE" + } + }, + "APPIUM_PYTHON_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_PYTHON_TEST_PACKAGE" + } + }, + "APPIUM_NODE_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_NODE_TEST_PACKAGE" + } + }, + "APPIUM_RUBY_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_RUBY_TEST_PACKAGE" + } + }, + "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE" + } + }, + "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE" + } + }, + "APPIUM_WEB_PYTHON_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_PYTHON_TEST_PACKAGE" + } + }, + "APPIUM_WEB_NODE_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_NODE_TEST_PACKAGE" + } + }, + "APPIUM_WEB_RUBY_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_RUBY_TEST_PACKAGE" + } + }, + "CALABASH_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALABASH_TEST_PACKAGE" + } + }, + "INSTRUMENTATION_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTRUMENTATION_TEST_PACKAGE" + } + }, + "UIAUTOMATION_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UIAUTOMATION_TEST_PACKAGE" + } + }, + "UIAUTOMATOR_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UIAUTOMATOR_TEST_PACKAGE" + } + }, + "XCTEST_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XCTEST_TEST_PACKAGE" + } + }, + "XCTEST_UI_TEST_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XCTEST_UI_TEST_PACKAGE" + } + }, + "APPIUM_JAVA_JUNIT_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_JUNIT_TEST_SPEC" + } + }, + "APPIUM_JAVA_TESTNG_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_JAVA_TESTNG_TEST_SPEC" + } + }, + "APPIUM_PYTHON_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_PYTHON_TEST_SPEC" + } + }, + "APPIUM_NODE_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_NODE_TEST_SPEC" + } + }, + "APPIUM_RUBY_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_RUBY_TEST_SPEC" + } + }, + "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC" + } + }, + "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC" + } + }, + "APPIUM_WEB_PYTHON_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_PYTHON_TEST_SPEC" + } + }, + "APPIUM_WEB_NODE_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_NODE_TEST_SPEC" + } + }, + "APPIUM_WEB_RUBY_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPIUM_WEB_RUBY_TEST_SPEC" + } + }, + "INSTRUMENTATION_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTRUMENTATION_TEST_SPEC" + } + }, + "XCTEST_UI_TEST_SPEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XCTEST_UI_TEST_SPEC" + } + } } }, "com.amazonaws.devicefarm#Uploads": { @@ -9196,9 +9583,59 @@ } }, "com.amazonaws.devicefarm#VideoCapture": { - "type": "boolean", + "type": "boolean" + }, + "com.amazonaws.devicefarm#VpcConfig": { + "type": "structure", + "members": { + "securityGroupIds": { + "target": "com.amazonaws.devicefarm#VpcSecurityGroupIds", + "traits": { + "smithy.api#documentation": "An array of one or more security groups IDs in your Amazon VPC.
", + "smithy.api#required": {} + } + }, + "subnetIds": { + "target": "com.amazonaws.devicefarm#VpcSubnetIds", + "traits": { + "smithy.api#documentation": "An array of one or more subnet IDs in your Amazon VPC.
", + "smithy.api#required": {} + } + }, + "vpcId": { + "target": "com.amazonaws.devicefarm#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the Amazon VPC.
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#box": {} + "smithy.api#documentation": "Contains the VPC configuration data necessary to interface with AWS Device Farm's services.
" + } + }, + "com.amazonaws.devicefarm#VpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.devicefarm#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.devicefarm#VpcSubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.devicefarm#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } } } } diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 4fc4b293e86..a10eb2fc9da 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -1299,7 +1299,7 @@ "target": "com.amazonaws.ec2#AllocateAddressResult" }, "traits": { - "smithy.api#documentation": "Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.
\nYou can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
\nAn Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
\nFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nYou can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nAllocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.
\nYou can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
\nAn Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
\nFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nYou can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nExclude a particular CIDR range from being returned by the pool.
", + "smithy.api#documentation": "Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
", "smithy.api#xmlName": "DisallowedCidr" } } @@ -1705,6 +1705,17 @@ } } }, + "com.amazonaws.ec2#AllocationType": { + "type": "enum", + "members": { + "used": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "used" + } + } + } + }, "com.amazonaws.ec2#AllowedPrincipal": { "type": "structure", "members": { @@ -3763,6 +3774,14 @@ "smithy.api#documentation": "The ID of a VPC peering connection.
", "smithy.api#xmlName": "vpcPeeringConnectionId" } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state. The following are the possible values:
\nactive
\nblackhole
\nOne or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
", + "smithy.api#documentation": "The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
", "smithy.api#xmlName": "ipv6Addresses" } }, @@ -4147,7 +4166,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
\nIf you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", + "smithy.api#documentation": "The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
\nIf you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", "smithy.api#xmlName": "privateIpAddress" } }, @@ -4244,7 +4263,7 @@ "target": "com.amazonaws.ec2#AssociateAddressResult" }, "traits": { - "smithy.api#documentation": "Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.
\n[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.
\n[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.
\nYou cannot associate an Elastic IP address with an interface in a different network border group.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nAssociates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.
\n[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.
\n[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.
\nYou cannot associate an Elastic IP address with an interface in a different network border group.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nAssociates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.
\n\t\t\n\t\tWhen the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
\n\t\t\n\t\tTo enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.
\n\t\t\n\t\tWhen the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
\n\t\t\n\t\tTo enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.
Adds the specified inbound (ingress) rules to a security group.
\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
\nFor more information about VPC security group quotas, see Amazon VPC quotas.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nAdds the specified inbound (ingress) rules to a security group.
\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
\nFor more information about VPC security group quotas, see Amazon VPC quotas.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, default VPC] The name of the security group. You must specify either the\n\t\t\tsecurity group ID or the security group name in the request.
" + "smithy.api#documentation": "[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.
" } }, "IpPermissions": { @@ -7696,6 +7715,41 @@ } } }, + "com.amazonaws.ec2#CapacityAllocation": { + "type": "structure", + "members": { + "AllocationType": { + "target": "com.amazonaws.ec2#AllocationType", + "traits": { + "aws.protocols#ec2QueryName": "AllocationType", + "smithy.api#documentation": "The usage type. used indicates that the instance capacity is \n\t\t\tin use by instances that are running in the Capacity Reservation.
The amount of instance capacity associated with the usage. For example a value of \n\t\t\t4 indicates that instance capacity for 4 instances is currently in use.
Information about instance capacity usage for a Capacity Reservation.
" + } + }, + "com.amazonaws.ec2#CapacityAllocations": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityAllocation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#CapacityReservation": { "type": "structure", "members": { @@ -7882,6 +7936,14 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tthe Capacity Reservation was created. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.
", "smithy.api#xmlName": "placementGroupArn" } + }, + "CapacityAllocations": { + "target": "com.amazonaws.ec2#CapacityAllocations", + "traits": { + "aws.protocols#ec2QueryName": "CapacityAllocationSet", + "smithy.api#documentation": "Information about instance capacity usage.
", + "smithy.api#xmlName": "capacityAllocationSet" + } } }, "traits": { @@ -9974,6 +10036,18 @@ } } }, + "com.amazonaws.ec2#ComponentAccount": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.ec2#ComponentRegion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-[1-9]+$" + } + }, "com.amazonaws.ec2#ConfirmProductInstance": { "type": "operation", "input": { @@ -13788,7 +13862,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" }, "traits": { - "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nFor more information about network interfaces, see Elastic Network Interfaces \n in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.
\nFor more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermission": { @@ -13897,7 +13971,7 @@ "aws.protocols#ec2QueryName": "Ipv6AddressCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set\n to true, you can specify 0 to override this setting.
The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.
\nYou can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
\nIf your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.\n You can't use this option if you're specifying a number of IPv6 addresses.
", + "smithy.api#documentation": "The IPv6 addresses from the IPv6 CIDR block range of your subnet.
\nYou can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", "smithy.api#xmlName": "ipv6Addresses" } }, @@ -13921,7 +13995,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "One or more private IPv4 addresses.
", + "smithy.api#documentation": "The private IPv4 addresses.
\nYou can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", "smithy.api#xmlName": "privateIpAddresses" } }, @@ -13931,14 +14005,14 @@ "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.
", + "smithy.api#documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { - "smithy.api#documentation": "One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The IPv4 prefixes assigned to the network interface.
\nYou can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", "smithy.api#xmlName": "Ipv4Prefix" } }, @@ -13947,13 +14021,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.
" } }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#Ipv6PrefixList", "traits": { - "smithy.api#documentation": "One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
The IPv6 prefixes assigned to the network interface.
\nYou can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
", "smithy.api#xmlName": "Ipv6Prefix" } }, @@ -13962,13 +14036,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
" } }, "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "The type of network interface. The default is interface.
The only supported values are efa and trunk.
The type of network interface. The default is interface.
The only supported values are efa and trunk.
Contains the parameters for CreateNetworkInterface.
" } }, "com.amazonaws.ec2#CreateNetworkInterfaceResult": { @@ -14019,9 +14090,6 @@ "smithy.api#xmlName": "clientToken" } } - }, - "traits": { - "smithy.api#documentation": "Contains the output of CreateNetworkInterface.
" } }, "com.amazonaws.ec2#CreatePlacementGroup": { @@ -14573,7 +14641,7 @@ "target": "com.amazonaws.ec2#CreateSecurityGroupResult" }, "traits": { - "smithy.api#documentation": "Creates a security group.
\nA security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWhen you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
\nYou have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nFor more information about VPC security group limits, see Amazon VPC Limits.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nCreates a security group.
\nA security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWhen you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
\nYou have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nFor more information about VPC security group limits, see Amazon VPC Limits.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nCreates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance. Boot volumes can be excluded by changing the \n parameters.
\n \t\nYou can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.
" + "smithy.api#documentation": "Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.
\n \nYou can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
\n \t\nYou can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.
" } }, "com.amazonaws.ec2#CreateSnapshotsRequest": { @@ -19529,7 +19597,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDeletes a security group.
\nIf you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.
We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
" + "smithy.api#documentation": "[EC2-Classic, default VPC] The name of the security group. You can specify either the\n security group name or the security group ID. For security groups in a nondefault VPC,\n you must specify the security group ID.
" } }, "DryRun": { @@ -21280,7 +21348,7 @@ "target": "com.amazonaws.ec2#DescribeAddressesResult" }, "traits": { - "smithy.api#documentation": "Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the specified Elastic IP addresses or all of your Elastic IP addresses.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nIf true, all deprecated AMIs are included in the response. If\n false, no deprecated AMIs are included in the response. If no value is\n specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
Specifies whether to include deprecated AMIs.
\nDefault: No deprecated AMIs are included in the response.
\nIf you are the AMI owner, all deprecated AMIs appear in the response regardless of what\n you specify for this parameter.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -27614,7 +27682,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters. The following are the possible values:
\nPathFound - A Boolean value that indicates whether a feasible path is found.
\nStatus - The status of the analysis (running | succeeded | failed).
\nThe filters. The following are the possible values:
\npath-found - A Boolean value that indicates whether a feasible path is found.
\nstatus - The status of the analysis (running | succeeded | failed).
\nThe filters. The following are the possible values:
\nDestination - The ID of the resource.
\nDestinationPort - The destination port.
\nName - The path name.
\nProtocol - The protocol.
\nSource - The ID of the resource.
\nThe filters. The following are the possible values:
\ndestination - The ID of the resource.
\ndestination-port - The destination port.
\nprotocol - The protocol.
\nsource - The ID of the resource.
\nOne or more network interface permission IDs.
", + "smithy.api#documentation": "The network interface permission IDs.
", "smithy.api#xmlName": "NetworkInterfacePermissionId" } }, @@ -28005,7 +28073,7 @@ "NetworkInterfaceIds": { "target": "com.amazonaws.ec2#NetworkInterfaceIdList", "traits": { - "smithy.api#documentation": "One or more network interface IDs.
\n\t\tDefault: Describes all your network interfaces.
", + "smithy.api#documentation": "The network interface IDs.
\n\t\tDefault: Describes all your network interfaces.
", "smithy.api#xmlName": "NetworkInterfaceId" } }, @@ -28510,7 +28578,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DescribeReservedInstancesListings": { @@ -28581,7 +28649,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" }, "traits": { - "smithy.api#documentation": "Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\n \tFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\n \tFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28652,7 +28720,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult" }, "traits": { - "smithy.api#documentation": "Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28973,7 +29041,7 @@ "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult" }, "traits": { - "smithy.api#documentation": "Finds available schedules that meet the specified criteria.
\nYou can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
\nAfter you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nFinds available schedules that meet the specified criteria.
\nYou can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
\nAfter you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29094,7 +29162,7 @@ "target": "com.amazonaws.ec2#DescribeScheduledInstancesResult" }, "traits": { - "smithy.api#documentation": "Describes the specified Scheduled Instances or all your Scheduled Instances.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the specified Scheduled Instances or all your Scheduled Instances.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29322,7 +29390,7 @@ "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" }, "traits": { - "smithy.api#documentation": "Describes the specified security groups or all of your security groups.
\nA security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the specified security groups or all of your security groups.
\nA security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nOne or more filters.
\n\n availability-zone - The Availability Zone for the subnet. You can also use\n availabilityZone as the filter name.
\n availability-zone-id - The ID of the Availability Zone for the subnet.\n You can also use availabilityZoneId as the filter name.
\n available-ip-address-count - The number of IPv4 addresses in the\n subnet that are available.
\n cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you\n specify must exactly match the subnet's CIDR block for information to be\n returned for the subnet. You can also use cidr or\n cidrBlock as the filter names.
\n default-for-az - Indicates whether this is the default subnet for the\n Availability Zone (true | false). You can also use \n defaultForAz as the filter name.
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the subnet.
\n ipv6-cidr-block-association.association-id - An association ID\n for an IPv6 CIDR block associated with the subnet.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the subnet.
\n ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
\n owner-id - The ID of the Amazon Web Services account that owns the subnet.
\n state - The state of the subnet (pending | available).
\n subnet-arn - The Amazon Resource Name (ARN) of the subnet.
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the subnet.
One or more filters.
\n\n availability-zone - The Availability Zone for the subnet. You can also use\n availabilityZone as the filter name.
\n availability-zone-id - The ID of the Availability Zone for the subnet.\n You can also use availabilityZoneId as the filter name.
\n available-ip-address-count - The number of IPv4 addresses in the\n subnet that are available.
\n cidr-block - The IPv4 CIDR block of the subnet. The CIDR block\n you specify must exactly match the subnet's CIDR block for information to be\n returned for the subnet. You can also use cidr or\n cidrBlock as the filter names.
\n customer-owned-ipv4-pool - The customer-owned IPv4 address pool\n associated with the subnet.
\n default-for-az - Indicates whether this is the default subnet for\n the Availability Zone (true | false). You can also use\n defaultForAz as the filter name.
\n enable-dns64 - Indicates whether DNS queries made to the\n Amazon-provided DNS Resolver in this subnet should return synthetic IPv6\n addresses for IPv4-only destinations.
\n enable-lni-at-device-index - Indicates the device position for\n local network interfaces in this subnet. For example, 1 indicates\n local network interfaces in this subnet are the secondary network interface\n (eth1).
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the subnet.
\n ipv6-cidr-block-association.association-id - An association ID\n for an IPv6 CIDR block associated with the subnet.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the subnet.
\n ipv6-native - Indicates whether this is an IPv6 only subnet\n (true | false).
\n map-customer-owned-ip-on-launch - Indicates whether a network\n interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
\n map-public-ip-on-launch - Indicates whether instances launched in\n this subnet receive a public IPv4 address.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
\n owner-id - The ID of the Amazon Web Services account that owns the\n subnet.
\n private-dns-name-options-on-launch.hostname-type - The type of\n hostname to assign to instances in the subnet at launch. For IPv4-only and\n dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the\n instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6\n only subnets, an instance DNS name must be based on the instance ID\n (resource-name).
\n private-dns-name-options-on-launch.enable-resource-name-dns-a-record\n - Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.
\n private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record\n - Indicates whether to respond to DNS queries for instance hostnames with DNS\n AAAA records.
\n state - The state of the subnet (pending | available).
\n subnet-arn - The Amazon Resource Name (ARN) of the subnet.
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the subnet.
Disassociates an Elastic IP address from the instance or network interface it's associated with.
\n\t\t\tAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" + "smithy.api#documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
\n\t\t\tAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" } }, "com.amazonaws.ec2#DisassociateAddressRequest": { @@ -35729,8 +35797,9 @@ "KmsKeyId": { "target": "com.amazonaws.ec2#String", "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", "smithy.api#documentation": "Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.
\nThis parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.
The transit gateway attachment.
", "smithy.api#xmlName": "transitGatewayAttachment" } + }, + "ComponentAccount": { + "target": "com.amazonaws.ec2#ComponentAccount", + "traits": { + "aws.protocols#ec2QueryName": "ComponentAccount", + "smithy.api#documentation": "The Amazon Web Services account for the component.
", + "smithy.api#xmlName": "componentAccount" + } + }, + "ComponentRegion": { + "target": "com.amazonaws.ec2#ComponentRegion", + "traits": { + "aws.protocols#ec2QueryName": "ComponentRegion", + "smithy.api#documentation": "The Region for the component.
", + "smithy.api#xmlName": "componentRegion" + } } }, "traits": { @@ -39401,7 +39486,7 @@ "target": "com.amazonaws.ec2#InstanceType", "traits": { "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "The instance type.
\nIf you specify InstanceTypes, you can't specify\n InstanceRequirements.
The instance type.
\nIf you specify InstanceType, you can't specify\n InstanceRequirements.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceType.
The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.
", + "smithy.api#xmlName": "imageId" + } } }, "traits": { @@ -39494,7 +39587,7 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "The instance type.
\nIf you specify InstanceTypes, you can't specify\n InstanceRequirements.
The instance type.
\nIf you specify InstanceType, you can't specify\n InstanceRequirements.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceType.
The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.
" } } }, @@ -45068,7 +45167,7 @@ "target": "com.amazonaws.ec2#ImportImageResult" }, "traits": { - "smithy.api#documentation": "Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
\nFor more information, see Importing a \n VM as an image using VM Import/Export in the VM Import/Export User Guide.
" + "smithy.api#documentation": "Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
\nAmazon Web Services VM Import/Export strongly recommends specifying a value for either the\n --license-type or --usage-operation parameter when you create a new\n VM Import task. This ensures your operating system is licensed appropriately and your billing is\n optimized.
For more information, see Importing a \n VM as an image using VM Import/Export in the VM Import/Export User Guide.
" } }, "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest": { @@ -45184,7 +45283,7 @@ "LicenseType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The license type to be used for the Amazon Machine Image (AMI) after importing.
\nBy default, we detect the source-system operating system (OS) and apply the appropriate license. Specify\n AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL\n to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as Amazon Web Services. For more information, see Prerequisites in the\n VM Import/Export User Guide.
The license type to be used for the Amazon Machine Image (AMI) after importing.
\nSpecify AWS to replace the source-system license with an Amazon Web Services\n license or BYOL to retain the source-system license. Leaving this parameter\n undefined is the same as choosing AWS when importing a Windows Server operating\n system, and the same as choosing BYOL when importing a Windows client operating\n system (such as Windows 10) or a Linux operating system.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as Amazon Web Services. For more information, see Prerequisites in the\n VM Import/Export User Guide.
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are\n returned. If you retrieve the IAM role credentials using a valid signed\n token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM\n role credentials always returns the version 2.0 credentials; the version 1.0 credentials\n are not available.
Default: optional\n
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Default: optional\n
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are\n returned. If you retrieve the IAM role credentials using a valid signed\n token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM\n role credential always returns the version 2.0 credentials; the version 1.0 credentials\n are not available.
Default: optional\n
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Default: optional\n
One or more security groups.
", + "smithy.api#documentation": "The security groups.
", "smithy.api#xmlName": "groupSet" } }, @@ -48150,7 +48249,7 @@ "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { "aws.protocols#ec2QueryName": "Ipv6AddressesSet", - "smithy.api#documentation": "One or more IPv6 addresses associated with the network interface.
", + "smithy.api#documentation": "The IPv6 addresses associated with the network interface.
", "smithy.api#xmlName": "ipv6AddressesSet" } }, @@ -48198,7 +48297,7 @@ "target": "com.amazonaws.ec2#InstancePrivateIpAddressList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "One or more private IPv4 addresses associated with the network interface.
", + "smithy.api#documentation": "The private IPv4 addresses associated with the network interface.
", "smithy.api#xmlName": "privateIpAddressesSet" } }, @@ -48446,7 +48545,7 @@ "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "One or more IPv6 addresses to assign to the network interface. You cannot specify\n this option and the option to assign a number of IPv6 addresses in the same request. You\n cannot specify this option if you've specified a minimum number of instances to\n launch.
", + "smithy.api#documentation": "The IPv6 addresses to assign to the network interface. You cannot specify\n this option and the option to assign a number of IPv6 addresses in the same request. You\n cannot specify this option if you've specified a minimum number of instances to\n launch.
", "smithy.api#xmlName": "ipv6AddressesSet" } }, @@ -48470,7 +48569,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.
", + "smithy.api#documentation": "The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.
", "smithy.api#xmlName": "privateIpAddressesSet" } }, @@ -48517,7 +48616,7 @@ "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { - "smithy.api#documentation": "One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv4PrefixCount option.
The IPv4 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv4PrefixCount option.
One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv6PrefixCount option.
The IPv6 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv6PrefixCount option.
The instance types to exclude. You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.
Default: No excluded instance types
", + "smithy.api#documentation": "The instance types to exclude.
\nYou can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.
Default: No excluded instance types
", "smithy.api#xmlName": "excludedInstanceTypeSet" } }, @@ -48774,7 +48873,7 @@ "target": "com.amazonaws.ec2#AcceleratorNameSet", "traits": { "aws.protocols#ec2QueryName": "AcceleratorNameSet", - "smithy.api#documentation": "The accelerators that must be on the instance type.
\nFor instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
", + "smithy.api#documentation": "The accelerators that must be on the instance type.
\nFor instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
Default: Any accelerator
", "smithy.api#xmlName": "acceleratorNameSet" } }, @@ -48788,7 +48887,7 @@ } }, "traits": { - "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nWhen you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.
\nYou must specify VCpuCount and MemoryMiB. All other parameters\n are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nWhen you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.
\nYou must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#InstanceRequirementsRequest": { @@ -48826,7 +48925,7 @@ "ExcludedInstanceTypes": { "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", "traits": { - "smithy.api#documentation": "The instance types to exclude. You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance family, type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.
Default: No excluded instance types
", + "smithy.api#documentation": "The instance types to exclude.
\nYou can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance family, type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.
Default: No excluded instance types
", "smithy.api#xmlName": "ExcludedInstanceType" } }, @@ -48927,7 +49026,7 @@ "AcceleratorNames": { "target": "com.amazonaws.ec2#AcceleratorNameSet", "traits": { - "smithy.api#documentation": "The accelerators that must be on the instance type.
\nFor instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
", + "smithy.api#documentation": "The accelerators that must be on the instance type.
\nFor instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
Default: Any accelerator
", "smithy.api#xmlName": "AcceleratorName" } }, @@ -48939,7 +49038,7 @@ } }, "traits": { - "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nWhen you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.
\nYou must specify VCpuCount and MemoryMiB. All other parameters\n are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nWhen you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.
\nYou must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest": { @@ -48990,6 +49089,7 @@ "ExcludeDataVolumeIds": { "target": "com.amazonaws.ec2#VolumeIdStringList", "traits": { + "smithy.api#documentation": "The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. \n If you specify the ID of the root volume, the request fails. To exclude the root volume, \n use ExcludeBootVolume.
\nYou can specify up to 40 volume IDs per request.
", "smithy.api#xmlName": "ExcludeDataVolumeId" } } @@ -52814,6 +52914,12 @@ "traits": { "smithy.api#enumValue": "p4de.24xlarge" } + }, + "u_3tb1_56xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-3tb1.56xlarge" + } } } }, @@ -54977,7 +55083,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv4Prefix", - "smithy.api#documentation": "One or more IPv4 delegated prefixes assigned to the network interface.
", + "smithy.api#documentation": "The IPv4 delegated prefixes assigned to the network interface.
", "smithy.api#xmlName": "ipv4Prefix" } } @@ -55194,7 +55300,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv6Prefix", - "smithy.api#documentation": "One or more IPv6 delegated prefixes assigned to the network interface.
", + "smithy.api#documentation": "The IPv6 delegated prefixes assigned to the network interface.
", "smithy.api#xmlName": "ipv6Prefix" } } @@ -55666,7 +55772,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the launch specification for an instance.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.
\nDescribes the launch specification for an instance.
" } }, "com.amazonaws.ec2#LaunchSpecsList": { @@ -57118,7 +57224,7 @@ "target": "com.amazonaws.ec2#InstanceRequirements", "traits": { "aws.protocols#ec2QueryName": "InstanceRequirements", - "smithy.api#documentation": "The instance requirements. When you specify instance requirements, Amazon EC2 will identify\n instance types with the provided requirements, and then use your On-Demand and Spot\n allocation strategies to launch instances from these instance types, in the same way as\n when you specify a list of instance types.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The instance requirements. When you specify instance requirements, Amazon EC2 will identify\n instance types with the provided requirements, and then use your On-Demand and Spot\n allocation strategies to launch instances from these instance types, in the same way as\n when you specify a list of instance types.
\nIf you specify InstanceRequirements, you can't specify\n InstanceType.
The name of the attribute.
", + "smithy.api#documentation": "The name of the attribute to modify.
\nYou can modify the following attributes only: disableApiTermination | instanceType | \n kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | \n userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | \n enaSupport | nvmeSupport | disableApiStop | enclaveOptions\n
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are\n returned. If you retrieve the IAM role credentials using a valid signed\n token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM\n role credential always returns the version 2.0 credentials; the version 1.0 credentials\n are not available.
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.
Modifies the Availability Zone, instance count, instance type, or network platform\n (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be\n modified must be identical, except for Availability Zone, network platform, and instance\n type.
\n\t\tFor more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nModifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.
\n\t\tFor more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nA private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
" + "smithy.api#documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
\nThe modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.
" } } }, @@ -63496,7 +63602,7 @@ "target": "com.amazonaws.ec2#MoveAddressToVpcResult" }, "traits": { - "smithy.api#documentation": "Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform, unless you move it back using the\n RestoreAddressToClassic request. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nMoves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform, unless you move it back using the\n RestoreAddressToClassic request. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the status of a moving Elastic IP address.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the status of a moving Elastic IP address.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThe route in a transit gateway route table.
", "smithy.api#xmlName": "transitGatewayRouteTableRoute" } + }, + "Explanations": { + "target": "com.amazonaws.ec2#ExplanationList", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationSet", + "smithy.api#documentation": "The explanation codes.
", + "smithy.api#xmlName": "explanationSet" + } + }, + "ElasticLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", + "smithy.api#documentation": "The load balancer listener.
", + "smithy.api#xmlName": "elasticLoadBalancerListener" + } } }, "traits": { @@ -67782,7 +67904,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "The private IPv4 addresses.
", + "smithy.api#documentation": "The private IPv4 address.
", "smithy.api#xmlName": "privateIpAddress" } } @@ -68628,7 +68750,7 @@ "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" }, "traits": { - "smithy.api#documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\n\t\tUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\n \tFor more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\n\t\tUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\n \tFor more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nPurchases the Scheduled Instances with the specified schedule.
\nScheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term.\n Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability\n to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance,\n you must call RunScheduledInstances during each scheduled time period.
\nAfter you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
" + "smithy.api#documentation": "You can no longer purchase Scheduled Instances.
\nPurchases the Scheduled Instances with the specified schedule.
\nScheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term.\n Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability\n to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance,\n you must call RunScheduledInstances during each scheduled time period.
\nAfter you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
" } }, "com.amazonaws.ec2#PurchaseScheduledInstancesRequest": { @@ -69599,7 +69721,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Releases the specified Elastic IP address.
\n[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.
\nFor more\n information, see Elastic IP\n Addresses in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Releases the specified Elastic IP address.
\n[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.
\nFor more\n information, see Elastic IP\n Addresses in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#ReleaseAddressRequest": { @@ -70695,7 +70817,7 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceTypes, you can't specify\n InstanceRequirements.
The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceType, you can't specify\n InstanceRequirements.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceType.
Creates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\n \nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.
\nCreates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\n \nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.
\nDescribes a launch request for one or more instances, and includes owner, requester,\n and security group information that applies to all instances in the launch\n request.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.
\nDescribes a launch request for one or more instances, and includes owner, requester,\n and security group information that applies to all instances in the launch\n request.
" } }, "com.amazonaws.ec2#ReservationFleetInstanceSpecification": { @@ -71703,7 +71825,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the configuration settings for the modified Reserved Instances.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes the configuration settings for the modified Reserved Instances.
" } }, "com.amazonaws.ec2#ReservedInstancesConfigurationList": { @@ -73354,7 +73476,7 @@ "target": "com.amazonaws.ec2#RestoreAddressToClassicResult" }, "traits": { - "smithy.api#documentation": "Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nRestores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nRemoves the specified inbound (ingress) rules from a security group.
\n\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\n[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\n\nRule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nRemoves the specified inbound (ingress) rules from a security group.
\n\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\n[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\n\nRule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
\n \nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request.
" + "smithy.api#documentation": "[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.
" } }, "IpPermissions": { @@ -74502,7 +74624,7 @@ "target": "com.amazonaws.ec2#Reservation" }, "traits": { - "smithy.api#documentation": "Launches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\n[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\n[EC2-Classic] If don't specify an Availability Zone, we choose one for\n you.
\nSome instance types must be launched into a VPC. If you do not have a default\n VPC, or if you do not specify a subnet ID, the request fails. For more\n information, see Instance types available only in a VPC.
\n[EC2-VPC] All instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
\n \nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.
\nLaunches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\n[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\n[EC2-Classic] If don't specify an Availability Zone, we choose one for\n you.
\nSome instance types must be launched into a VPC. If you do not have a default\n VPC, or if you do not specify a subnet ID, the request fails. For more\n information, see Instance types available only in a VPC.
\n[EC2-VPC] All instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.
\nDescribes a Scheduled Instance.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes a Scheduled Instance.
" } }, "com.amazonaws.ec2#ScheduledInstanceAvailability": { @@ -75220,7 +75342,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a schedule that is available for your Scheduled Instances.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes a schedule that is available for your Scheduled Instances.
" } }, "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet": { @@ -77893,13 +78015,13 @@ "target": "com.amazonaws.ec2#InstanceRequirements", "traits": { "aws.protocols#ec2QueryName": "InstanceRequirements", - "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceType.
Describes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you\n can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.
\nDescribes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you\n can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the Spot Fleet request.
\nIf the allocation strategy is lowestPrice, Spot Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from\n all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching. To give certain instance types a higher chance of launching first,\n use capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You\n can assign the same priority to different LaunchTemplateOverrides. EC2\n implements the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
\n\n lowestPrice - Spot Fleet launches instances from the lowest-price Spot Instance pool\n that has available capacity. If the cheapest pool doesn't have available capacity, the\n Spot Instances come from the next cheapest pool that has available capacity. If a pool runs out\n of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next cheapest pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools.
\n diversified - Spot Fleet launches instances from all of the Spot Instance pools that you\n specify.
\n capacityOptimized (recommended) - Spot Fleet launches instances from Spot Instance pools\n with optimal capacity for the number of instances that are launching. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowestPrice\n
The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.
The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.
The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .
The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet.
\n\n lowest-price - EC2 Fleet launches instances from the Spot Instance pools with the lowest\n price.
\n diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you\n specify.
\n capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools\n with optimal capacity for the number of instances that are launching. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowest-price\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\n\n lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that\n has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances\n come from the next cheapest pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next cheapest pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools.
\n diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you\n specify.
\n capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools\n with optimal capacity for the number of instances that are launching. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowest-price\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the EC2 Fleet.
\n\n lowest-price - EC2 Fleet launches instances from\n the Spot Instance pools with the lowest price.
\n diversified - EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.
\n capacity-optimized (recommended) - EC2 Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances that\n are launching. To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowest-price\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\n\n lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that\n has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances\n come from the next cheapest pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next cheapest pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools.
\n diversified - EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.
\n capacity-optimized (recommended) - EC2 Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances that\n are launching. To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowest-price\n
One or more IPv6 prefixes to unassign from the network interface.
", + "smithy.api#documentation": "The IPv6 prefixes to unassign from the network interface.
", "smithy.api#xmlName": "Ipv6Prefix" } }, @@ -85357,7 +85479,7 @@ "GroupName": { "target": "com.amazonaws.ec2#SecurityGroupName", "traits": { - "smithy.api#documentation": "[EC2-Classic, default VPC] The name of the security group. You must specify either the\n\t\t\tsecurity group ID or the security group name in the request.
" + "smithy.api#documentation": "[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.
" } }, "IpPermissions": { @@ -85547,7 +85669,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a security group and Amazon Web Services account ID pair.
\nWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nDescribes a security group and Amazon Web Services account ID pair.
\nWe are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
\nThe configuration for an application to automatically stop after a certain amount of time being idle.
" + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of\n time being idle.
" } }, "networkConfiguration": { @@ -210,7 +210,7 @@ } }, "com.amazonaws.emrserverless#ApplicationStateSet": { - "type": "set", + "type": "list", "member": { "target": "com.amazonaws.emrserverless#ApplicationState" }, @@ -218,7 +218,8 @@ "smithy.api#length": { "min": 1, "max": 7 - } + }, + "smithy.api#uniqueItems": {} } }, "com.amazonaws.emrserverless#ApplicationSummary": { @@ -297,7 +298,7 @@ "enabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Enables the application to automatically start on job submission. Defaults to true.
" + "smithy.api#documentation": "Enables the application to automatically start on job submission. Defaults to\n true.
" } } }, @@ -311,14 +312,14 @@ "enabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
" + "smithy.api#documentation": "Enables the application to automatically stop after a certain amount of time being idle.\n Defaults to true.
" } }, "idleTimeoutMinutes": { "target": "smithy.api#Integer", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
", + "smithy.api#default": null, + "smithy.api#documentation": "The amount of idle time in minutes after which your application will automatically stop.\n Defaults to 15 minutes.
", "smithy.api#range": { "min": 1, "max": 10080 @@ -327,11 +328,31 @@ } }, "traits": { - "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of time being idle.
" + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of\n time being idle.
" } }, "com.amazonaws.emrserverless#AwsToledoWebService": { "type": "service", + "version": "2021-07-13", + "operations": [ + { + "target": "com.amazonaws.emrserverless#ListTagsForResource" + }, + { + "target": "com.amazonaws.emrserverless#TagResource" + }, + { + "target": "com.amazonaws.emrserverless#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.emrserverless#ApplicationResource" + }, + { + "target": "com.amazonaws.emrserverless#JobRunResource" + } + ], "traits": { "aws.api#service": { "sdkId": "EMR Serverless", @@ -364,27 +385,7 @@ }, "smithy.api#documentation": "Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides\n a serverless runtime environment that simplifies running analytics applications using the\n latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless,\n you don’t have to configure, optimize, secure, or operate clusters to run applications with\n these frameworks.
\nThe API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR Serverless. For example,\n aws emr-serverless start-job-run.
It is the prefix before IAM policy actions for Amazon EMR Serverless. For example,\n \"Action\": [\"emr-serverless:StartJobRun\"]. For more information, see\n Policy actions for Amazon EMR Serverless.
It is the prefix used in Amazon EMR Serverless service endpoints. For example,\n emr-serverless.us-east-2.amazonaws.com.
The configuration for an application to automatically stop after a certain amount of time being idle.
" + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of\n time being idle.
" } }, "networkConfiguration": { @@ -738,6 +739,7 @@ "com.amazonaws.emrserverless#Duration": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1000000 @@ -845,6 +847,67 @@ } } }, + "com.amazonaws.emrserverless#GetDashboardForJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a URL to access the job run dashboard.
", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}/dashboard" + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRunResponse": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.emrserverless#Url", + "traits": { + "smithy.api#documentation": "The URL to view job run's dashboard.
" + } + } + } + }, "com.amazonaws.emrserverless#GetJobRun": { "type": "operation", "input": { @@ -976,6 +1039,7 @@ "workerCount": { "target": "com.amazonaws.emrserverless#WorkerCounts", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of workers in the initial capacity configuration.
", "smithy.api#required": {} } @@ -1156,7 +1220,7 @@ "totalResourceUtilization": { "target": "com.amazonaws.emrserverless#TotalResourceUtilization", "traits": { - "smithy.api#documentation": "The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated,\n rounded up to the nearest second.
" + "smithy.api#documentation": "The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.
" } }, "networkConfiguration": { @@ -1165,7 +1229,7 @@ "totalExecutionDurationSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED, FAILED, or CANCELLED state.
The job run total execution duration in seconds. This field is only available for job\n runs in a COMPLETED, FAILED, or CANCELLED\n state.
The maximum number of applications that can be listed.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { @@ -1414,7 +1484,7 @@ "states": { "target": "com.amazonaws.emrserverless#ApplicationStateSet", "traits": { - "smithy.api#documentation": "An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
", + "smithy.api#documentation": "An optional filter for application states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.
", "smithy.api#httpQuery": "states" } } @@ -1491,7 +1561,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of job runs that can be listed.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { @@ -1517,7 +1587,7 @@ "states": { "target": "com.amazonaws.emrserverless#JobRunStateSet", "traits": { - "smithy.api#documentation": "An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
", + "smithy.api#documentation": "An optional filter for job run states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.
", "smithy.api#httpQuery": "states" } } @@ -1575,7 +1645,7 @@ "resourceArn": { "target": "com.amazonaws.emrserverless#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1599,7 +1669,7 @@ "enabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Enables managed logging and defaults to true. If set to false, managed logging will be turned off.
" + "smithy.api#documentation": "Enables managed logging and defaults to true. If set to false, managed logging will be\n turned off.
" } }, "encryptionKeyArn": { @@ -1998,8 +2068,8 @@ "executionTimeoutMinutes": { "target": "com.amazonaws.emrserverless#Duration", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
" + "smithy.api#default": null, + "smithy.api#documentation": "The maximum duration for the job run to run. If the job run runs beyond this duration,\n it will be automatically cancelled.
" } }, "name": { @@ -2196,7 +2266,7 @@ "resourceArn": { "target": "com.amazonaws.emrserverless#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2230,24 +2300,24 @@ "vCPUHour": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The aggregated vCPU used per hour from the time job start executing till the time job is terminated.
" + "smithy.api#documentation": "The aggregated vCPU used per hour from the time job start executing till the time job is\n terminated.
" } }, "memoryGBHour": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The aggregated memory used per hour from the time job start executing till the time job is terminated.
" + "smithy.api#documentation": "The aggregated memory used per hour from the time job start executing till the time job\n is terminated.
" } }, "storageGBHour": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The aggregated storage used per hour from the time job start executing till the time job is terminated.
" + "smithy.api#documentation": "The aggregated storage used per hour from the time job start executing till the time job\n is terminated.
" } } }, "traits": { - "smithy.api#documentation": "The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated,\n rounded up to the nearest second.
" + "smithy.api#documentation": "The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.
" } }, "com.amazonaws.emrserverless#UntagResource": { @@ -2284,7 +2354,7 @@ "resourceArn": { "target": "com.amazonaws.emrserverless#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2371,7 +2441,7 @@ "autoStopConfiguration": { "target": "com.amazonaws.emrserverless#AutoStopConfig", "traits": { - "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of time being idle.
" + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of\n time being idle.
" } }, "networkConfiguration": { @@ -2401,6 +2471,15 @@ "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" } }, + "com.amazonaws.emrserverless#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.emrserverless#ValidationException": { "type": "structure", "members": { @@ -2420,6 +2499,7 @@ "com.amazonaws.emrserverless#WorkerCounts": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000000 diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index d6162772772..f8209ae5fd5 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -42,21 +42,6 @@ }, "com.amazonaws.fsx#AWSSimbaAPIService_v20180301": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "FSx", - "arnNamespace": "fsx", - "cloudFormationName": "FSx", - "cloudTrailEventSource": "fsx.amazonaws.com", - "endpointPrefix": "fsx" - }, - "aws.auth#sigv4": { - "name": "fsx" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon FSx is a fully managed service that makes it easy for storage and\n application administrators to launch and use shared file storage.
", - "smithy.api#title": "Amazon FSx" - }, "version": "2018-03-01", "operations": [ { @@ -77,6 +62,9 @@ { "target": "com.amazonaws.fsx#CreateDataRepositoryTask" }, + { + "target": "com.amazonaws.fsx#CreateFileCache" + }, { "target": "com.amazonaws.fsx#CreateFileSystem" }, @@ -101,6 +89,9 @@ { "target": "com.amazonaws.fsx#DeleteDataRepositoryAssociation" }, + { + "target": "com.amazonaws.fsx#DeleteFileCache" + }, { "target": "com.amazonaws.fsx#DeleteFileSystem" }, @@ -122,6 +113,9 @@ { "target": "com.amazonaws.fsx#DescribeDataRepositoryTasks" }, + { + "target": "com.amazonaws.fsx#DescribeFileCaches" + }, { "target": "com.amazonaws.fsx#DescribeFileSystemAliases" }, @@ -158,6 +152,9 @@ { "target": "com.amazonaws.fsx#UpdateDataRepositoryAssociation" }, + { + "target": "com.amazonaws.fsx#UpdateFileCache" + }, { "target": "com.amazonaws.fsx#UpdateFileSystem" }, @@ -170,7 +167,22 @@ { "target": "com.amazonaws.fsx#UpdateVolume" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "FSx", + "arnNamespace": "fsx", + "cloudFormationName": "FSx", + "cloudTrailEventSource": "fsx.amazonaws.com", + "endpointPrefix": "fsx" + }, + "aws.auth#sigv4": { + "name": "fsx" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon FSx is a fully managed service that makes it easy for storage and\n application administrators to launch and use shared file storage.
", + "smithy.api#title": "Amazon FSx" + } }, "com.amazonaws.fsx#ActiveDirectoryBackupAttributes": { "type": "structure", @@ -221,27 +233,35 @@ } }, "com.amazonaws.fsx#ActiveDirectoryErrorType": { - "type": "string", + "type": "enum", + "members": { + "DOMAIN_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_NOT_FOUND" + } + }, + "INCOMPATIBLE_DOMAIN_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPATIBLE_DOMAIN_MODE" + } + }, + "WRONG_VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRONG_VPC" + } + }, + "INVALID_DOMAIN_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DOMAIN_STAGE" + } + } + }, "traits": { - "smithy.api#documentation": "The type of error relating to Microsoft Active Directory. NOT_FOUND means that no\n directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the\n directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified\n directory isn't accessible from the specified VPC. WRONG_STAGE means that the\n specified directory isn't currently in the ACTIVE state.
", - "smithy.api#enum": [ - { - "value": "DOMAIN_NOT_FOUND", - "name": "DOMAIN_NOT_FOUND" - }, - { - "value": "INCOMPATIBLE_DOMAIN_MODE", - "name": "INCOMPATIBLE_DOMAIN_MODE" - }, - { - "value": "WRONG_VPC", - "name": "WRONG_VPC" - }, - { - "value": "INVALID_DOMAIN_STAGE", - "name": "INVALID_DOMAIN_STAGE" - } - ] + "smithy.api#documentation": "The type of error relating to Microsoft Active Directory. NOT_FOUND means that no\n directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the\n directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified\n directory isn't accessible from the specified VPC. WRONG_STAGE means that the\n specified directory isn't currently in the ACTIVE state.
" } }, "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName": { @@ -324,39 +344,53 @@ } }, "com.amazonaws.fsx#AdministrativeActionType": { - "type": "string", + "type": "enum", + "members": { + "FILE_SYSTEM_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_SYSTEM_UPDATE" + } + }, + "STORAGE_OPTIMIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_OPTIMIZATION" + } + }, + "FILE_SYSTEM_ALIAS_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_SYSTEM_ALIAS_ASSOCIATION" + } + }, + "FILE_SYSTEM_ALIAS_DISASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_SYSTEM_ALIAS_DISASSOCIATION" + } + }, + "VOLUME_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOLUME_UPDATE" + } + }, + "SNAPSHOT_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT_UPDATE" + } + }, + "RELEASE_NFS_V3_LOCKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEASE_NFS_V3_LOCKS" + } + } + }, "traits": { - "smithy.api#documentation": "Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
The AutoExportPolicy can have the following event values:
\n NEW - Amazon FSx automatically exports new files and\n directories to the data repository as they are added to the file system.
\n CHANGED - Amazon FSx automatically exports changes to\n files and directories on the file system to the data repository.
\n DELETED - Files and directories are automatically deleted\n on the data repository when they are deleted on the file system.
You can define any combination of event types for your AutoExportPolicy.
The AutoExportPolicy can have the following event values:
\n NEW - New files and directories are automatically exported\n to the data repository as they are added to the file system.
\n CHANGED - Changes to files and directories on the\n file system are automatically exported to the data repository.
\n DELETED - Files and directories are automatically deleted\n on the data repository when they are deleted on the file system.
You can define any combination of event types for your AutoExportPolicy.
Describes a data repository association's automatic export policy. The\n AutoExportPolicy defines the types of updated objects on the\n file system that will be automatically exported to the data repository.\n As you create, modify, or delete files, Amazon FSx automatically\n exports the defined changes asynchronously once your application finishes\n modifying the file.
This AutoExportPolicy is supported only for file systems with the\n Persistent_2 deployment type.
Describes a data repository association's automatic export policy. The\n AutoExportPolicy defines the types of updated objects on the\n file system that will be automatically exported to the data repository.\n As you create, modify, or delete files, Amazon FSx for Lustre \n automatically exports the defined changes asynchronously once your application finishes\n modifying the file.
This AutoExportPolicy is supported only for Amazon FSx for Lustre\n file systems with the Persistent_2 deployment type.
Describes the data repository association's automatic import policy.\n The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\n listings up to date by importing changes to your file system as you modify\n objects in a linked S3 bucket.
\nThis AutoImportPolicy is supported only for file systems\n with the Persistent_2 deployment type.
Describes the data repository association's automatic import policy.\n The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\n listings up to date by importing changes to your Amazon FSx for Lustre file system\n as you modify objects in a linked S3 bucket.
\nThe AutoImportPolicy is supported only for Amazon FSx for Lustre\n file systems with the Persistent_2 deployment type.
The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 0.
The lifecycle status of the backup.
\n\n AVAILABLE - The backup is fully available.
\n PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
\n CREATING - Amazon FSx is creating the new user-initiated backup.
\n TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file\n system.
\n COPYING - Amazon FSx is copying the backup.
\n DELETED - Amazon FSx deleted the backup and it's no longer\n available.
\n FAILED - Amazon FSx couldn't finish the backup.
The lifecycle status of the backup.
\n\n AVAILABLE - The backup is fully available.
\n PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
\n CREATING - Amazon FSx is creating the new user-initiated backup.
\n TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file\n system.
\n COPYING - Amazon FSx is copying the backup.
\n DELETED - Amazon FSx deleted the backup and it's no longer\n available.
\n FAILED - Amazon FSx couldn't finish the backup.
The type of the backup.
", - "smithy.api#enum": [ - { - "value": "AUTOMATIC", - "name": "AUTOMATIC" - }, - { - "value": "USER_INITIATED", - "name": "USER_INITIATED" - }, - { - "value": "AWS_BACKUP", - "name": "AWS_BACKUP" + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "USER_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_INITIATED" + } + }, + "AWS_BACKUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_BACKUP" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The type of the backup.
" } }, "com.amazonaws.fsx#Backups": { @@ -864,10 +931,7 @@ } }, "com.amazonaws.fsx#BatchImportMetaDataOnCreate": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.fsx#CancelDataRepositoryTask": { "type": "operation", @@ -931,6 +995,15 @@ } } }, + "com.amazonaws.fsx#CapacityToRelease": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2147483647 + } + } + }, "com.amazonaws.fsx#ClientRequestToken": { "type": "string", "traits": { @@ -978,7 +1051,6 @@ "com.amazonaws.fsx#CoolingPeriod": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 2, "max": 183 @@ -1077,6 +1149,9 @@ } } }, + "com.amazonaws.fsx#CopyTagsToDataRepositoryAssociations": { + "type": "boolean" + }, "com.amazonaws.fsx#CreateBackup": { "type": "operation", "input": { @@ -1192,7 +1267,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported only\n for file systems with the Persistent_2 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
", + "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported only\n for file systems with the Persistent_2 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
\n\n CreateDataRepositoryAssociation isn't supported\n on Amazon File Cache resources. To create a DRA on Amazon File Cache,\n use the CreateFileCache operation.
A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.
This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
\nIf you specify only a forward slash (/) as the file system\n path, you can link only 1 data repository to the file system. You can only specify\n \"/\" as the file system path for the first data repository associated with a file system.
A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.
This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
\nIf you specify only a forward slash (/) as the file system\n path, you can link only one data repository to the file system. You can only specify\n \"/\" as the file system path for the first data repository associated with a file system.
Specifies the amount of data to release, in GiB, by an Amazon File Cache\n AUTO_RELEASE_DATA task that automatically releases files from the cache.
Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem API operation:
Amazon FSx for Lustre
\nAmazon FSx for NetApp ONTAP
\nAmazon FSx for OpenZFS
\nAmazon FSx for Windows File Server
\nThis operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING.
Returns the description of the file system in JSON format.
\nThis operation requires a client request token in the request that Amazon FSx\n uses to ensure idempotent creation. This means that calling the operation multiple times\n with the same client request token has no effect. By using the idempotent operation, you\n can retry a CreateFileSystem operation without the risk of creating an\n extra file system. This approach can be useful when an initial call fails in a way that\n makes it unclear whether a file system was created. Examples are if a transport-level\n timeout occurred, or your connection was reset. If you use the same client request token\n and the initial call created a file system, the client receives a success message as\n long as the parameters are the same.
The CreateFileSystem call returns while the file system's lifecycle\n state is still CREATING. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.
Creates a new Amazon File Cache resource.
\nYou can use this operation with a client request token in the request that\n Amazon File Cache uses to ensure idempotent creation. \n If a cache with the specified client request token exists and the parameters\n match, CreateFileCache returns the description of the existing\n cache. If a cache with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError.\n If a file cache with the specified client request token doesn't exist,\n CreateFileCache does the following:
Creates a new, empty Amazon File Cache resourcewith an assigned ID, and\n an initial lifecycle state of CREATING.
Returns the description of the cache in JSON format.
\nThe CreateFileCache call returns while the cache's lifecycle\n state is still CREATING. You can check the cache creation status\n by calling the DescribeFileCaches operation, which returns the cache state\n along with other information.
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File\n Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
\n \nIf a file system with the specified client request token exists and the parameters\n match, this operation returns the description of the file system. If a file system\n with the specified client request token exists but the parameters don't match, this\n call returns IncompatibleParameterError. If a file system with the\n specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID,\n and an initial lifecycle state of CREATING.
Returns the description of the file system.
\nParameters like the Active Directory, default share name, automatic backup, and backup\n settings default to the parameters of the file system that was backed up, unless\n overridden. You can explicitly supply other settings.
\n\nBy using the idempotent operation, you can retry a\n CreateFileSystemFromBackup call without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives a success message as long as the\n parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's\n lifecycle state is still CREATING. You can check the file-system\n creation status by calling the \n DescribeFileSystems operation, which returns the file system state along\n with other information.
Provisions the amount of read and write throughput for each 1 tebibyte (TiB)\n of cache storage capacity, in MB/s/TiB. The only supported\n value is 1000.
Specifies the cache deployment type, which must be CACHE_1.
The configuration for a Lustre MDT (Metadata Target) storage volume.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon File Cache configuration for the cache that you are creating.
" + } + }, + "com.amazonaws.fsx#CreateFileCacheRequest": { + "type": "structure", + "members": { "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "An idempotency token for resource creation, in a string of up to 64\n ASCII characters. This token is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
\nBy using the idempotent operation, you can retry a CreateFileCache\n operation without the risk of creating an extra cache. This approach can be useful\n when an initial call fails in a way that makes it unclear whether a cache was created.\n Examples are if a transport level timeout occurred, or your connection was reset.\n If you use the same client request token and the initial call created a cache, the\n client receives success as long as the parameters are the same.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 \n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID property.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment\n types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The\n file server is launched in that subnet's Availability Zone.
The type of cache that you're creating, which\n must be LUSTRE.
A list of IDs for the security groups that apply to the specified network interfaces\n created for file system access. These security groups apply to all network interfaces.\n This value isn't returned in later DescribeFileSystem requests.
Sets the Lustre version for the cache that you're creating,\n which must be 2.12.
The storage capacity of the cache in gibibytes (GiB). Valid values\n are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.fsx#SubnetIds", + "traits": { + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.fsx#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "A list of IDs specifying the security groups to apply to all network interfaces\n created for Amazon File Cache access. This list isn't returned in later requests to\n describe the cache.
" + } + }, + "Tags": { + "target": "com.amazonaws.fsx#Tags" + }, + "CopyTagsToDataRepositoryAssociations": { + "target": "com.amazonaws.fsx#CopyTagsToDataRepositoryAssociations", + "traits": { + "smithy.api#documentation": "A boolean flag indicating whether tags for the cache should be copied to\n data repository associations. This value defaults to false.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on\n an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed\n KMS key for your account is used. For more information,\n see Encrypt in the\n Key Management Service API Reference.
The configuration for the Amazon File Cache resource being created.
" + } + }, + "DataRepositoryAssociations": { + "target": "com.amazonaws.fsx#CreateFileCacheDataRepositoryAssociations", + "traits": { + "smithy.api#documentation": "A list of up to 8 configurations for data repository associations (DRAs) to\n be created during the cache creation. The DRAs link the cache to either an\n Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
\nThe DRA configurations must meet the following requirements:
\nAll configurations on the list must be of the\n same data repository type, either all S3 or all NFS. A cache\n can't link to different data repository types at the same time.
\nAn NFS DRA must link to an NFS file system that\n supports the NFSv3 protocol.
\nDRA automatic import and automatic export is not supported.
" + } + } + } + }, + "com.amazonaws.fsx#CreateFileCacheResponse": { + "type": "structure", + "members": { + "FileCache": { + "target": "com.amazonaws.fsx#FileCacheCreating", + "traits": { + "smithy.api#documentation": "A description of the cache that was created.
" + } + } + } + }, + "com.amazonaws.fsx#CreateFileSystem": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#CreateFileSystemRequest" + }, + "output": { + "target": "com.amazonaws.fsx#CreateFileSystemResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#ActiveDirectoryError" + }, + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#IncompatibleParameterError" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + }, + { + "target": "com.amazonaws.fsx#InvalidExportPath" + }, + { + "target": "com.amazonaws.fsx#InvalidImportPath" + }, + { + "target": "com.amazonaws.fsx#InvalidNetworkSettings" + }, + { + "target": "com.amazonaws.fsx#InvalidPerUnitStorageThroughput" + }, + { + "target": "com.amazonaws.fsx#MissingFileSystemConfiguration" + }, + { + "target": "com.amazonaws.fsx#ServiceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem API operation:
Amazon FSx for Lustre
\nAmazon FSx for NetApp ONTAP
\nAmazon FSx for OpenZFS
\nAmazon FSx for Windows File Server
\nThis operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING.
Returns the description of the file system in JSON format.
\nThe CreateFileSystem call returns while the file system's lifecycle\n state is still CREATING. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File\n Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
\n \nIf a file system with the specified client request token exists and the parameters\n match, this operation returns the description of the file system. If a file system\n with the specified client request token exists but the parameters don't match, this\n call returns IncompatibleParameterError. If a file system with the\n specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID,\n and an initial lifecycle state of CREATING.
Returns the description of the file system.
\nParameters like the Active Directory, default share name, automatic backup, and backup\n settings default to the parameters of the file system that was backed up, unless\n overridden. You can explicitly supply other settings.
\n\nBy using the idempotent operation, you can retry a\n CreateFileSystemFromBackup call without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives a success message as long as the\n parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's\n lifecycle state is still CREATING. You can check the file-system\n creation status by calling the \n DescribeFileSystems operation, which returns the file system state along\n with other information.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#idempotencyToken": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.fsx#SubnetIds", + "traits": { + "smithy.api#documentation": "Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 \n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID property.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment\n types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The\n file server is launched in that subnet's Availability Zone.
A list of IDs for the security groups that apply to the specified network interfaces\n created for file system access. These security groups apply to all network interfaces.\n This value isn't returned in later DescribeFileSystem requests.
The tags to be applied to the file system at file system creation. The key value of\n the Name tag appears in the console as the file system\n name.
The OpenZFS configuration for the file system that's being created.
" } + }, + "StorageCapacity": { + "target": "com.amazonaws.fsx#StorageCapacity", + "traits": { + "smithy.api#documentation": "Sets the storage capacity of the OpenZFS file system that you're creating\n from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB\n (512 TiB). However, the value that you specify must be equal to or greater than the\n backup's storage capacity value. If you don't use the StorageCapacity\n parameter, the default is the backup's StorageCapacity value.
If used to create a file system other than OpenZFS, you must provide a value\n that matches the backup's StorageCapacity value. If you provide any\n other value, Amazon FSx responds with a 400 Bad Request.
Describes the state of a data repository association. The lifecycle can have\n the following values:
\n\n CREATING - The data repository association between \n the FSx file system and the S3 data repository is being created. \n The data repository is unavailable.
\n AVAILABLE - The data repository association is\n available for use.
\n MISCONFIGURED - Amazon FSx cannot automatically import updates\n from the S3 bucket or automatically export updates to the S3 bucket until the data\n repository association configuration is corrected.
\n UPDATING - The data repository association is undergoing\n a customer initiated update that might affect its availability.
\n DELETING - The data repository association is undergoing\n a customer initiated deletion.
\n FAILED - The data repository association is in a terminal\n state that cannot be recovered.
Describes the state of a data repository association. The lifecycle can have\n the following values:
\n\n CREATING - The data repository association between \n the file system or cache and the data repository is being created. \n The data repository is unavailable.
\n AVAILABLE - The data repository association is\n available for use.
\n MISCONFIGURED - The data repository association is\n misconfigured. Until the configuration is corrected, automatic import and\n automatic export will not work (only for Amazon FSx for Lustre).
\n UPDATING - The data repository association is undergoing\n a customer initiated update that might affect its availability.
\n DELETING - The data repository association is undergoing\n a customer initiated deletion.
\n FAILED - The data repository association is in a terminal\n state that cannot be recovered.
A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.
This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
\nIf you specify only a forward slash (/) as the file system\n path, you can link only 1 data repository to the file system. You can only specify\n \"/\" as the file system path for the first data repository associated with a file system.
A path on the Amazon FSx for Lustre file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.
This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
\nIf you specify only a forward slash (/) as the file system\n path, you can link only one data repository to the file system. You can only specify\n \"/\" as the file system path for the first data repository associated with a file system.
The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix/. This path specifies where in the S3\n data repository files will be imported from or exported to.
The path to the data repository that will be linked to the cache\n or file system.
\nFor Amazon File Cache, the path can be an NFS data repository\n that will be linked to the cache. The path can be in one of two formats:
\nIf you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nsf://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.
For Amazon File Cache, the path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.
For Amazon FSx for Lustre, the path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.
A boolean flag indicating whether an import data repository task to import\n metadata should run after the data repository association is created. The\n task runs if this flag is set to true.
A boolean flag indicating whether an import data repository task to import\n metadata should run after the data repository association is created. The\n task runs if this flag is set to true.
\n BatchImportMetaDataOnCreate is not supported for data repositories\n linked to an Amazon File Cache resource.
For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + "smithy.api#documentation": "For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system or cache.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" } }, "S3": { "target": "com.amazonaws.fsx#S3DataRepositoryConfiguration", "traits": { - "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration defines which file events (new, changed, or\n deleted files or directories) are automatically imported from\n the linked data repository to the file system or automatically\n exported from the file system to the data repository.
" + "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx for Lustre file system with a data repository association.
" } }, "Tags": { @@ -2464,10 +2715,34 @@ }, "CreationTime": { "target": "com.amazonaws.fsx#CreationTime" + }, + "FileCacheId": { + "target": "com.amazonaws.fsx#FileCacheId", + "traits": { + "smithy.api#documentation": "The globally unique ID of the Amazon File Cache resource.
" + } + }, + "FileCachePath": { + "target": "com.amazonaws.fsx#Namespace", + "traits": { + "smithy.api#documentation": "A path on the Amazon File Cache that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the path is required. Two data repository\n associations cannot have overlapping cache paths. For example, if\n a data repository is associated with cache path /ns1/,\n then you cannot link another data repository with cache\n path /ns1/ns2.
This path specifies the directory in your cache where files will be exported\n from. This cache directory can be linked to only one data repository\n (S3 or NFS) and no other data repository can be linked to the directory.
\nThe cache path can only be set to root (/) on an NFS DRA when\n DataRepositorySubdirectories is specified. If you\n specify root (/) as the cache path, you can create only one DRA\n on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
\nFor Amazon File Cache, a list of NFS Exports that will be linked with an\n NFS data repository association. All the subdirectories must be on a single NFS file system.\n The Export paths are in the format /exportpath1.\n To use this parameter, you must configure DataRepositoryPath\n as the domain name of the NFS file system. The NFS file system domain name in effect is the\n root of the subdirectories. Note that DataRepositorySubdirectories is not\n supported for S3 data repositories.
The configuration for an NFS data repository linked to an\n Amazon File Cache resource with a data repository association.
" + } } }, "traits": { - "smithy.api#documentation": "The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket.\n The data repository association configuration object is returned \n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported only for file systems\n with the Persistent_2 deployment type.
The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket\n or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system.\n The data repository association configuration object is returned\n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported only for an Amazon FSx for Lustre\n file system with the Persistent_2 deployment type and for an\n Amazon File Cache resource.
The lifecycle status of the data repository task, as follows:
\n\n PENDING - Amazon FSx has not started the task.
\n EXECUTING - Amazon FSx is processing the task.
\n FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. \n The DataRepositoryTaskFailureDetails property provides more information about task failures.
\n SUCCEEDED - FSx completed the task successfully.
\n CANCELED - Amazon FSx canceled the task and it did not complete.
\n CANCELING - FSx is in process of canceling the task.
You cannot delete an FSx for Lustre file system if there are data \n repository tasks for the file system in the PENDING or EXECUTING states.\n Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). \n You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
The lifecycle status of the data repository task, as follows:
\n\n PENDING - The task has not started.
\n EXECUTING - The task is in process.
\n FAILED - The task was not able to be completed. For example, there may be files the task failed to process. \n The DataRepositoryTaskFailureDetails property provides more information about task failures.
\n SUCCEEDED - The task has completed successfully.
\n CANCELED - The task was canceled and it did not complete.
\n CANCELING - The task is in process of being canceled.
You cannot delete an FSx for Lustre file system if there are data \n repository tasks for the file system in the PENDING or EXECUTING states.\n Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). \n You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
The type of data repository task.
\nThe EXPORT_TO_REPOSITORY data repository task exports\n from your Lustre file system from to a linked S3 bucket.
The IMPORT_METADATA_FROM_REPOSITORY data repository task\n imports metadata changes from a linked S3 bucket to your Lustre file system.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
The time that Amazon FSx began processing the task.
" + "smithy.api#documentation": "The time the system began processing the task.
" } }, "EndTime": { "target": "com.amazonaws.fsx#EndTime", "traits": { - "smithy.api#documentation": "The time that Amazon FSx completed processing the task, populated after the task is complete.
" + "smithy.api#documentation": "The time the system completed processing the task, populated after the task is complete.
" } }, "ResourceARN": { @@ -2650,13 +2935,13 @@ "FileSystemId": { "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "The globally unique ID of the file system.
" } }, "Paths": { "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", "traits": { - "smithy.api#documentation": "An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process. \n For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
\n(Default) If Paths is not specified, Amazon FSx uses the file system root directory.
An array of paths that specify the data for the data repository task to process. \n For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export\n to the linked data repository.
\n(Default) If Paths is not specified, Amazon FSx uses the file system root directory.
Specifies the amount of data to release, in GiB, by an Amazon File Cache\n AUTO_RELEASE_DATA task that automatically releases files from the cache.
" + } + }, + "FileCacheId": { + "target": "com.amazonaws.fsx#FileCacheId", + "traits": { + "smithy.api#documentation": "The system-generated, unique ID of the cache.
" + } } }, "traits": { - "smithy.api#documentation": "A description of the data repository task. You use data repository tasks\n to perform bulk transfer operations between your Amazon FSx file system and a linked data\n repository.
" + "smithy.api#documentation": "A description of the data repository task. You use data repository tasks\n to perform bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository. An Amazon File Cache resource uses a task to\n automatically release files from the cache.
" } }, "com.amazonaws.fsx#DataRepositoryTaskEnded": { @@ -2735,22 +3032,32 @@ } }, "com.amazonaws.fsx#DataRepositoryTaskFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "file-system-id", - "name": "FILE_SYSTEM_ID" - }, - { - "value": "task-lifecycle", - "name": "TASK_LIFECYCLE" - }, - { - "value": "data-repository-association-id", - "name": "DATA_REPO_ASSOCIATION_ID" + "type": "enum", + "members": { + "FILE_SYSTEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-system-id" + } + }, + "TASK_LIFECYCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "task-lifecycle" + } + }, + "DATA_REPO_ASSOCIATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "data-repository-association-id" + } + }, + "FILE_CACHE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-cache-id" } - ] + } } }, "com.amazonaws.fsx#DataRepositoryTaskFilterValue": { @@ -2788,34 +3095,44 @@ } }, "com.amazonaws.fsx#DataRepositoryTaskLifecycle": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "EXECUTING", - "name": "EXECUTING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "CANCELED", - "name": "CANCELED" - }, - { - "value": "CANCELING", - "name": "CANCELING" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELED" + } + }, + "CANCELING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELING" + } + } } }, "com.amazonaws.fsx#DataRepositoryTaskNotFound": { @@ -2878,6 +3195,12 @@ "traits": { "smithy.api#documentation": "The time at which the task status was last updated.
" } + }, + "ReleasedCapacity": { + "target": "com.amazonaws.fsx#ReleasedCapacity", + "traits": { + "smithy.api#documentation": "The total amount of data, in GiB, released by an Amazon File Cache\n AUTO_RELEASE_DATA task that automatically releases files from the cache.
" + } } }, "traits": { @@ -2885,19 +3208,33 @@ } }, "com.amazonaws.fsx#DataRepositoryTaskType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EXPORT_TO_REPOSITORY", - "name": "EXPORT" - }, - { - "value": "IMPORT_METADATA_FROM_REPOSITORY", - "name": "IMPORT" + "type": "enum", + "members": { + "EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPORT_TO_REPOSITORY" } - ] - } + }, + "IMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_METADATA_FROM_REPOSITORY" + } + }, + "EVICTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEASE_DATA_FROM_FILESYSTEM" + } + }, + "AUTO_TRIGGERED_EVICTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_RELEASE_DATA" + } + } + } }, "com.amazonaws.fsx#DataRepositoryTasks": { "type": "list", @@ -2990,10 +3327,7 @@ } }, "com.amazonaws.fsx#DeleteDataInFileSystem": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.fsx#DeleteDataRepositoryAssociation": { "type": "operation", @@ -3044,8 +3378,7 @@ "DeleteDataInFileSystem": { "target": "com.amazonaws.fsx#DeleteDataInFileSystem", "traits": { - "smithy.api#documentation": "Set to true to delete the data in the file system that corresponds\n to the data repository association.
Set to true to delete the data in the file system that corresponds\n to the data repository association.
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data\n is gone.
\n \nThe DeleteFileCache operation returns while the cache has the\n DELETING status. You can check the cache deletion status by\n calling the DescribeFileCaches operation, which returns a list of caches in your\n account. If you pass the cache ID for a deleted cache, the\n DescribeFileCaches operation returns a FileCacheNotFound\n error.
The data in a deleted cache is also deleted and can't be recovered by\n any means.
\nThe ID of the cache that's being deleted.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.fsx#DeleteFileCacheResponse": { + "type": "structure", + "members": { + "FileCacheId": { + "target": "com.amazonaws.fsx#FileCacheId", + "traits": { + "smithy.api#documentation": "The ID of the cache that's being deleted.
" + } + }, + "Lifecycle": { + "target": "com.amazonaws.fsx#FileCacheLifecycle", + "traits": { + "smithy.api#documentation": "The cache lifecycle for the deletion request. If the\n DeleteFileCache operation is successful, this status is\n DELETING.
Returns the description of specific Amazon FSx for Lustre data repository associations, if\n one or more AssociationIds values are provided in the request, or if filters are\n used in the request. Data repository associations are supported only\n for file systems with the Persistent_2 deployment type.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3).\n If you don't use filters, the response returns all data repository associations\n owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint\n that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, Amazon FSx returns a\n NextToken value in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache\n data repository associations, if one or more AssociationIds values\n are provided in the request, or if filters are used in the request. Data repository\n associations are supported only for Amazon FSx for Lustre file systems with the\n Persistent_2 deployment type and for Amazon File Cache resources.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or caches (use the file-cache-id filter with\n the ID of the cache), or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3\n or NFS). If you don't use filters, the response returns all data\n repository associations owned by your Amazon Web Services account in the Amazon Web Services Region\n of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, a\n NextToken value is returned in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
An array of one ore more data repository association descriptions.
" + "smithy.api#documentation": "An array of one or more data repository association descriptions.
" } }, "NextToken": { @@ -3760,7 +4158,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the description of specific Amazon FSx for Lustre data repository tasks, if\n one or more TaskIds values are provided in the request, or if filters are used in the request. \n You can use filters to narrow the response to include just tasks for specific file systems, \n or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned \n by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults\n parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon\n FSx returns a NextToken value in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if\n one or more TaskIds values are provided in the request, or if filters are used in the request. \n You can use filters to narrow the response to include just tasks for specific file systems or caches, \n or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned \n by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults\n parameter to limit the number of tasks returned in a response. If more tasks remain,\n a NextToken value is returned in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
Returns the description of a specific Amazon File Cache resource, if a\n FileCacheIds value is provided for that cache. Otherwise, it\n returns descriptions of all caches owned by your Amazon Web Services account in the\n Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the\n MaxResults parameter to limit the number of descriptions in a response.\n If more cache descriptions remain, the operation returns a\n NextToken value in the response. In this case, send a later request\n with the NextToken request parameter set to the value of\n NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache\n descriptions. DescribeFileCaches is called first without a\n NextTokenvalue. Then the operation continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.
When using this operation, keep the following in mind:
\nThe implementation might return fewer than MaxResults\n cache descriptions while still including a NextToken\n value.
The order of caches returned in the response of one\n DescribeFileCaches call and the order of caches returned\n across the responses of a multicall iteration is unspecified.
IDs of the caches whose descriptions you want to retrieve (String).
" + } + }, + "MaxResults": { + "target": "com.amazonaws.fsx#MaxResults" + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken" + } + } + }, + "com.amazonaws.fsx#DescribeFileCachesResponse": { + "type": "structure", + "members": { + "FileCaches": { + "target": "com.amazonaws.fsx#FileCaches", + "traits": { + "smithy.api#documentation": "The response object for the DescribeFileCaches operation.
Returns the description of specific Amazon FSx file systems, if a\n FileSystemIds value is provided for that file system. Otherwise, it\n returns descriptions of all file systems owned by your Amazon Web Services account in the\n Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the\n MaxResults parameter to limit the number of descriptions in a response.\n If more file system descriptions remain, Amazon FSx returns a\n NextToken value in the response. In this case, send a later request\n with the NextToken request parameter set to the value of\n NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system\n descriptions. DescribeFileSystems is called first without a\n NextTokenvalue. Then the operation continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.
When using this operation, keep the following in mind:
\nThe implementation might return fewer than MaxResults file\n system descriptions while still including a NextToken\n value.
The order of file systems returned in the response of one\n DescribeFileSystems call and the order of file systems returned\n across the responses of a multicall iteration is unspecified.
Returns the description of specific Amazon FSx file systems, if a\n FileSystemIds value is provided for that file system. Otherwise, it\n returns descriptions of all file systems owned by your Amazon Web Services account in the\n Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the\n MaxResults parameter to limit the number of descriptions in a response.\n If more file system descriptions remain, Amazon FSx returns a\n NextToken value in the response. In this case, send a later request\n with the NextToken request parameter set to the value of\n NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system\n descriptions. DescribeFileSystems is called first without a\n NextTokenvalue. Then the operation continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.
When using this operation, keep the following in mind:
\nThe implementation might return fewer than MaxResults file\n system descriptions while still including a NextToken\n value.
The order of file systems returned in the response of one\n DescribeFileSystems call and the order of file systems returned\n across the responses of a multicall iteration is unspecified.
The system-generated, unique ID of the cache.
" + } + }, + "FileCacheType": { + "target": "com.amazonaws.fsx#FileCacheType", + "traits": { + "smithy.api#documentation": "The type of cache, which must be LUSTRE.
The Lustre version of the cache, which must be 2.12.
The lifecycle status of the cache. The following are the possible values and\n what they mean:
\n\n AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
\n CREATING - The new cache is being created.
\n DELETING - An existing cache is being deleted.
\n UPDATING - The cache is undergoing a customer-initiated update.
\n FAILED - An existing cache has experienced an unrecoverable failure. \n When creating a new cache, the cache was unable to be created.
A structure providing details of any failures that occurred.
" + } + }, + "StorageCapacity": { + "target": "com.amazonaws.fsx#StorageCapacity", + "traits": { + "smithy.api#documentation": "The storage capacity of the cache in gibibytes (GiB).
" + } + }, + "VpcId": { + "target": "com.amazonaws.fsx#VpcId" + }, + "SubnetIds": { + "target": "com.amazonaws.fsx#SubnetIds" + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.fsx#NetworkInterfaceIds" + }, + "DNSName": { + "target": "com.amazonaws.fsx#DNSName", + "traits": { + "smithy.api#documentation": "The Domain Name System (DNS) name for the cache.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on\n an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed\n KMS key for your account is used. For more information,\n see Encrypt in the\n Key Management Service API Reference.
The configuration for the Amazon File Cache resource.
" + } + }, + "DataRepositoryAssociationIds": { + "target": "com.amazonaws.fsx#DataRepositoryAssociationIds", + "traits": { + "smithy.api#documentation": "A list of IDs of data repository associations that are associated with this cache.
" + } + } + }, "traits": { - "smithy.api#box": {} + "smithy.api#documentation": "A description of a specific Amazon File Cache resource, which is\n a response object from the DescribeFileCaches operation.
The system-generated, unique ID of the cache.
" + } + }, + "FileCacheType": { + "target": "com.amazonaws.fsx#FileCacheType", + "traits": { + "smithy.api#documentation": "The type of cache, which must be LUSTRE.
The Lustre version of the cache, which must be 2.12.
The lifecycle status of the cache. The following are the possible values and\n what they mean:
\n\n AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
\n CREATING - The new cache is being created.
\n DELETING - An existing cache is being deleted.
\n UPDATING - The cache is undergoing a customer-initiated update.
\n FAILED - An existing cache has experienced an unrecoverable failure. \n When creating a new cache, the cache was unable to be created.
A structure providing details of any failures that occurred.
" + } + }, + "StorageCapacity": { + "target": "com.amazonaws.fsx#StorageCapacity", + "traits": { + "smithy.api#documentation": "The storage capacity of the cache in gibibytes (GiB).
" + } + }, + "VpcId": { + "target": "com.amazonaws.fsx#VpcId" + }, + "SubnetIds": { + "target": "com.amazonaws.fsx#SubnetIds" + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.fsx#NetworkInterfaceIds" + }, + "DNSName": { + "target": "com.amazonaws.fsx#DNSName", + "traits": { + "smithy.api#documentation": "The Domain Name System (DNS) name for the cache.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on\n an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed\n KMS key for your account is used. For more information,\n see Encrypt in the\n Key Management Service API Reference.
A boolean flag indicating whether tags for the cache should be copied to\n data repository associations.
" + } + }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#FileCacheLustreConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the Amazon File Cache resource.
" + } + }, + "DataRepositoryAssociationIds": { + "target": "com.amazonaws.fsx#DataRepositoryAssociationIds", + "traits": { + "smithy.api#documentation": "A list of IDs of data repository associations that are associated with this cache.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response object for the Amazon File Cache resource being created in the\n CreateFileCache operation.
A path on the cache that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping cache paths. For example, if\n a data repository is associated with cache path /ns1/,\n then you cannot link another data repository with cache\n path /ns1/ns2.
This path specifies where in your cache files will be exported\n from. This cache directory can be linked to only one data repository,\n and no data repository other can be linked to the directory.
\nThe cache path can only be set to root (/) on an NFS DRA when\n DataRepositorySubdirectories is specified. If you\n specify root (/) as the cache path, you can create only one DRA\n on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
\nThe path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:
\nThe path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:
\nIf you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nsf://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.
The path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.
A list of NFS Exports that will be linked with this data repository\n association. The Export paths are in the format /exportpath1.\n To use this parameter, you must configure DataRepositoryPath\n as the domain name of the NFS file system. The NFS file system domain name in effect is the\n root of the subdirectories. Note that DataRepositorySubdirectories\n is not supported for S3 data repositories.
The configuration for a data repository association that\n links an Amazon File Cache resource to an NFS data repository.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a data repository association (DRA) to\n be created during the Amazon File Cache resource creation. The DRA\n links the cache to either an Amazon S3 bucket or prefix, or a Network File\n System (NFS) data repository that supports the NFSv3 protocol.
\nThe DRA does not support automatic import or automatic\n export.
" + } + }, + "com.amazonaws.fsx#FileCacheFailureDetails": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing any failures that occurred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure providing details of any failures that occurred.
" + } + }, + "com.amazonaws.fsx#FileCacheId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 21 + }, + "smithy.api#pattern": "^(fc-[0-9a-f]{8,})$" + } + }, + "com.amazonaws.fsx#FileCacheIds": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#FileCacheId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.fsx#FileCacheLifecycle": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.fsx#FileCacheLustreConfiguration": { + "type": "structure", + "members": { + "PerUnitStorageThroughput": { + "target": "com.amazonaws.fsx#PerUnitStorageThroughput", + "traits": { + "smithy.api#documentation": "Per unit storage throughput represents the megabytes per second of read or write\n throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is\n equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only\n supported value is 1000.
The deployment type of the Amazon File Cache resource, which must\n be CACHE_1.
You use the MountName value when mounting the cache. If you pass\n a cache ID to the DescribeFileCaches operation, it returns the\n the MountName value as part of the cache's description.
The configuration for a Lustre MDT (Metadata Target) storage volume.
" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.fsx#LustreLogConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for Lustre logging used to write the enabled\n logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the Amazon File Cache resource.
" + } + }, + "com.amazonaws.fsx#FileCacheLustreDeploymentType": { + "type": "enum", + "members": { + "CACHE_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CACHE_1" + } + } + } + }, + "com.amazonaws.fsx#FileCacheLustreMetadataConfiguration": { + "type": "structure", + "members": { + "StorageCapacity": { + "target": "com.amazonaws.fsx#MetadataStorageCapacity", + "traits": { + "smithy.api#documentation": "The storage capacity of the Lustre MDT (Metadata Target) storage\n volume in gibibytes (GiB). The only supported value is 2400 GiB.
The configuration for a Lustre MDT (Metadata Target) storage volume.\n The metadata on Amazon File Cache is managed by a Lustre Metadata Server\n (MDS) while the actual metadata is persisted on an MDT.
" + } + }, + "com.amazonaws.fsx#FileCacheNFSConfiguration": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.fsx#NfsVersion", + "traits": { + "smithy.api#documentation": "The version of the NFS (Network File System) protocol of the\n NFS data repository. The only supported value is NFS3,\n which indicates that the data repository must support the NFSv3 protocol.
A list of up to 2 IP addresses of DNS servers used to resolve\n the NFS file system domain name. The provided IP addresses can either\n be the IP addresses of a DNS forwarder or resolver that the customer\n manages and runs inside the customer VPC, or the IP addresses of the\n on-premises DNS servers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an NFS data repository association (DRA)\n created during the creation of the Amazon File Cache resource.
" + } + }, + "com.amazonaws.fsx#FileCacheNotFound": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "No caches were found based upon supplied parameters.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.fsx#FileCacheType": { + "type": "enum", + "members": { + "LUSTRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LUSTRE" + } + } + } + }, + "com.amazonaws.fsx#FileCaches": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#FileCache" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } } }, "com.amazonaws.fsx#FileSystem": { @@ -4579,55 +5451,73 @@ } }, "com.amazonaws.fsx#FileSystemLifecycle": { - "type": "string", + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "MISCONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONFIGURED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "MISCONFIGURED_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONFIGURED_UNAVAILABLE" + } + } + }, "traits": { - "smithy.api#documentation": "The lifecycle status of the file system.
", - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "MISCONFIGURED", - "name": "MISCONFIGURED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "MISCONFIGURED_UNAVAILABLE", - "name": "MISCONFIGURED_UNAVAILABLE" - } - ] + "smithy.api#documentation": "The lifecycle status of the file system.
" } }, "com.amazonaws.fsx#FileSystemMaintenanceOperation": { - "type": "string", - "traits": { - "smithy.api#documentation": "An enumeration specifying the currently ongoing maintenance operation.
", - "smithy.api#enum": [ - { - "value": "PATCHING", - "name": "PATCHING" - }, - { - "value": "BACKING_UP", - "name": "BACKING_UP" + "type": "enum", + "members": { + "PATCHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATCHING" + } + }, + "BACKING_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKING_UP" } - ] + } + }, + "traits": { + "smithy.api#documentation": "An enumeration specifying the currently ongoing maintenance operation.
" } }, "com.amazonaws.fsx#FileSystemMaintenanceOperations": { @@ -4656,27 +5546,35 @@ } }, "com.amazonaws.fsx#FileSystemType": { - "type": "string", + "type": "enum", + "members": { + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + }, + "LUSTRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LUSTRE" + } + }, + "ONTAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONTAP" + } + }, + "OPENZFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENZFS" + } + } + }, "traits": { - "smithy.api#documentation": "The type of file system.
", - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "WINDOWS" - }, - { - "value": "LUSTRE", - "name": "LUSTRE" - }, - { - "value": "ONTAP", - "name": "ONTAP" - }, - { - "value": "OPENZFS", - "name": "OPENZFS" - } - ] + "smithy.api#documentation": "The type of file system.
" } }, "com.amazonaws.fsx#FileSystemTypeVersion": { @@ -4723,31 +5621,53 @@ } }, "com.amazonaws.fsx#FilterName": { - "type": "string", + "type": "enum", + "members": { + "FILE_SYSTEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-system-id" + } + }, + "BACKUP_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "backup-type" + } + }, + "FILE_SYSTEM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-system-type" + } + }, + "VOLUME_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume-id" + } + }, + "DATA_REPOSITORY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "data-repository-type" + } + }, + "FILE_CACHE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-cache-id" + } + }, + "FILE_CACHE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-cache-type" + } + } + }, "traits": { - "smithy.api#documentation": "The name for a filter.
", - "smithy.api#enum": [ - { - "value": "file-system-id", - "name": "FILE_SYSTEM_ID" - }, - { - "value": "backup-type", - "name": "BACKUP_TYPE" - }, - { - "value": "file-system-type", - "name": "FILE_SYSTEM_TYPE" - }, - { - "value": "volume-id", - "name": "VOLUME_ID" - }, - { - "value": "data-repository-type", - "name": "DATA_REPOSITORY_TYPE" - } - ] + "smithy.api#documentation": "The name for a filter.
" } }, "com.amazonaws.fsx#FilterValue": { @@ -4788,28 +5708,29 @@ } }, "com.amazonaws.fsx#Flag": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.fsx#FlexCacheEndpointType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "ORIGIN", - "name": "ORIGIN" - }, - { - "value": "CACHE", - "name": "CACHE" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ORIGIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORIGIN" } - ] + }, + "CACHE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CACHE" + } + } } }, "com.amazonaws.fsx#GeneralARN": { @@ -4856,7 +5777,6 @@ "com.amazonaws.fsx#IntegerNoMax": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 2147483647 @@ -4866,7 +5786,6 @@ "com.amazonaws.fsx#IntegerNoMaxFromNegativeOne": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": -1, "max": 2147483647 @@ -4876,7 +5795,6 @@ "com.amazonaws.fsx#IntegerRecordSizeKiB": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 4, "max": 1024 @@ -5015,7 +5933,6 @@ "com.amazonaws.fsx#Iops": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 160000 @@ -5080,7 +5997,6 @@ "com.amazonaws.fsx#LimitedMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 25 @@ -5169,49 +6085,61 @@ } }, "com.amazonaws.fsx#LustreAccessAuditLogLevel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "WARN_ONLY", - "name": "WARN_ONLY" - }, - { - "value": "ERROR_ONLY", - "name": "ERROR_ONLY" - }, - { - "value": "WARN_ERROR", - "name": "WARN_ERROR" - } - ] + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "WARN_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN_ONLY" + } + }, + "ERROR_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR_ONLY" + } + }, + "WARN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN_ERROR" + } + } } }, "com.amazonaws.fsx#LustreDeploymentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SCRATCH_1", - "name": "SCRATCH_1" - }, - { - "value": "SCRATCH_2", - "name": "SCRATCH_2" - }, - { - "value": "PERSISTENT_1", - "name": "PERSISTENT_1" - }, - { - "value": "PERSISTENT_2", - "name": "PERSISTENT_2" - } - ] + "type": "enum", + "members": { + "SCRATCH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCRATCH_1" + } + }, + "SCRATCH_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCRATCH_2" + } + }, + "PERSISTENT_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSISTENT_1" + } + }, + "PERSISTENT_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSISTENT_2" + } + } } }, "com.amazonaws.fsx#LustreFileSystemConfiguration": { @@ -5301,7 +6229,7 @@ "Level": { "target": "com.amazonaws.fsx#LustreAccessAuditLogLevel", "traits": { - "smithy.api#documentation": "The data repository events that are logged by Amazon FSx.
\n\n WARN_ONLY - only warning events are logged.
\n ERROR_ONLY - only error events are logged.
\n WARN_ERROR - both warning events and error events\n are logged.
\n DISABLED - logging of data repository events\n is turned off.
The data repository events that are logged by Amazon FSx.
\n\n WARN_ONLY - only warning events are logged.
\n ERROR_ONLY - only error events are logged.
\n WARN_ERROR - both warning events and error events\n are logged.
\n DISABLED - logging of data repository events\n is turned off.
Note that Amazon File Cache uses a default setting of WARN_ERROR,\n which can't be changed.
The configuration for Lustre logging used to write the enabled\n logging events for your file system to Amazon CloudWatch Logs.
\nWhen logging is enabled, Lustre logs error and warning events\n from data repository operations such as automatic export and data repository tasks.\n To learn more about Lustre logging, see \n Logging with Amazon CloudWatch Logs.\n
" + "smithy.api#documentation": "The configuration for Lustre logging used to write the enabled\n logging events for your Amazon FSx for Lustre file system or\n Amazon File Cache resource to Amazon CloudWatch Logs.
" } }, "com.amazonaws.fsx#LustreLogCreateConfiguration": { @@ -5329,12 +6257,12 @@ "Destination": { "target": "com.amazonaws.fsx#GeneralARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that specifies the destination of the logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN, with the following\n requirements:
\nThe destination ARN that you provide must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix.
If you do not provide a destination, Amazon FSx will create and use a\n log stream in the CloudWatch Logs /aws/fsx/lustre log group.
If Destination is provided and the resource does not\n exist, the request will fail with a BadRequest error.
If Level is set to DISABLED, you cannot specify\n a destination in Destination.
The Amazon Resource Name (ARN) that specifies the destination of the logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN, with the following\n requirements:
\nThe destination ARN that you provide must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix.
If you do not provide a destination, Amazon FSx will create and use a\n log stream in the CloudWatch Logs /aws/fsx/lustre log group\n (for Amazon FSx for Lustre) or /aws/fsx/filecache\n (for Amazon File Cache).
If Destination is provided and the resource does not\n exist, the request will fail with a BadRequest error.
If Level is set to DISABLED, you cannot specify\n a destination in Destination.
The Lustre logging configuration used when creating or updating an\n Amazon FSx for Lustre file system. Lustre logging writes the enabled\n logging events for your file system to Amazon CloudWatch Logs.
\nError and warning events can be logged from the following data\n repository operations:
\nAutomatic export
\nData repository tasks
\nTo learn more about Lustre logging, see \n Logging to Amazon CloudWatch Logs.
" + "smithy.api#documentation": "The Lustre logging configuration used when creating or updating an\n Amazon FSx for Lustre file system. An Amazon File Cache is created\n with Lustre logging enabled by default, with a setting of\n WARN_ERROR for the logging events. which can't be changed.
Lustre logging writes the enabled logging events for your file system\n or cache to Amazon CloudWatch Logs.
" } }, "com.amazonaws.fsx#LustreNoSquashNid": { @@ -5392,7 +6320,6 @@ "com.amazonaws.fsx#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of resources to return in the response. This value must be an\n integer greater than zero.
", "smithy.api#range": { "min": 1, @@ -5403,7 +6330,6 @@ "com.amazonaws.fsx#Megabytes": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 512000 @@ -5413,7 +6339,6 @@ "com.amazonaws.fsx#MegabytesPerSecond": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).
", "smithy.api#range": { "min": 8, @@ -5421,6 +6346,27 @@ } } }, + "com.amazonaws.fsx#MetadataStorageCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.fsx#MissingFileCacheConfiguration": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "A cache configuration is required for this operation.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.fsx#MissingFileSystemConfiguration": { "type": "structure", "members": { @@ -5445,6 +6391,33 @@ "smithy.api#error": "client" } }, + "com.amazonaws.fsx#NFSDataRepositoryConfiguration": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.fsx#NfsVersion", + "traits": { + "smithy.api#documentation": "The version of the NFS (Network File System) protocol of the\n NFS data repository. Currently, the only supported value is\n NFS3, which indicates that the data repository must\n support the NFSv3 protocol.
A list of up to 2 IP addresses of DNS servers used to resolve\n the NFS file system domain name. The provided IP addresses can either\n be the IP addresses of a DNS forwarder or resolver that the customer\n manages and runs inside the customer VPC, or the IP addresses of the\n on-premises DNS servers.
" + } + }, + "AutoExportPolicy": { + "target": "com.amazonaws.fsx#AutoExportPolicy", + "traits": { + "smithy.api#documentation": "This parameter is not supported for Amazon File Cache.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a data repository association that\n links an Amazon File Cache resource to an NFS data repository.
" + } + }, "com.amazonaws.fsx#Namespace": { "type": "string", "traits": { @@ -5500,6 +6473,17 @@ "smithy.api#pattern": "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$" } }, + "com.amazonaws.fsx#NfsVersion": { + "type": "enum", + "members": { + "NFS3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NFS3" + } + } + } + }, "com.amazonaws.fsx#NotServiceResourceError": { "type": "structure", "members": { @@ -5520,18 +6504,20 @@ } }, "com.amazonaws.fsx#OntapDeploymentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MULTI_AZ_1", - "name": "MULTI_AZ_1" - }, - { - "value": "SINGLE_AZ_1", - "name": "SINGLE_AZ_1" + "type": "enum", + "members": { + "MULTI_AZ_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_AZ_1" + } + }, + "SINGLE_AZ_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_AZ_1" } - ] + } } }, "com.amazonaws.fsx#OntapEndpointIpAddresses": { @@ -5668,22 +6654,26 @@ } }, "com.amazonaws.fsx#OntapVolumeType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RW", - "name": "RW" - }, - { - "value": "DP", - "name": "DP" - }, - { - "value": "LS", - "name": "LS" + "type": "enum", + "members": { + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "DP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DP" } - ] + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + } } }, "com.amazonaws.fsx#OpenZFSClientConfiguration": { @@ -5731,18 +6721,20 @@ } }, "com.amazonaws.fsx#OpenZFSCopyStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CLONE", - "name": "CLONE" - }, - { - "value": "FULL_COPY", - "name": "FULL_COPY" + "type": "enum", + "members": { + "CLONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLONE" } - ] + }, + "FULL_COPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_COPY" + } + } } }, "com.amazonaws.fsx#OpenZFSCreateRootVolumeConfiguration": { @@ -5790,33 +6782,37 @@ } }, "com.amazonaws.fsx#OpenZFSDataCompressionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "ZSTD", - "name": "ZSTD" - }, - { - "value": "LZ4", - "name": "LZ4" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" } - ] + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "LZ4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LZ4" + } + } } }, "com.amazonaws.fsx#OpenZFSDeploymentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SINGLE_AZ_1", - "name": "SINGLE_AZ_1" + "type": "enum", + "members": { + "SINGLE_AZ_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_AZ_1" } - ] + } } }, "com.amazonaws.fsx#OpenZFSFileSystemConfiguration": { @@ -5936,18 +6932,20 @@ } }, "com.amazonaws.fsx#OpenZFSQuotaType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USER", - "name": "USER" - }, - { - "value": "GROUP", - "name": "GROUP" + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" } - ] + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + } } }, "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas": { @@ -6087,7 +7085,6 @@ "com.amazonaws.fsx#PerUnitStorageThroughput": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 12, "max": 1000 @@ -6097,7 +7094,6 @@ "com.amazonaws.fsx#ProgressPercent": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The current percent of progress of an asynchronous task.
", "smithy.api#range": { "min": 0, @@ -6106,10 +7102,7 @@ } }, "com.amazonaws.fsx#ReadOnly": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.fsx#Region": { "type": "string", @@ -6176,26 +7169,41 @@ } } }, + "com.amazonaws.fsx#ReleasedCapacity": { + "type": "long" + }, "com.amazonaws.fsx#ReportFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REPORT_CSV_20191124", - "name": "REPORT_CSV_20191124" + "type": "enum", + "members": { + "REPORT_CSV_20191124": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPORT_CSV_20191124" } - ] + } } }, "com.amazonaws.fsx#ReportScope": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FAILED_FILES_ONLY", - "name": "FAILED_FILES_ONLY" + "type": "enum", + "members": { + "FAILED_FILES_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_FILES_ONLY" } - ] + } + } + }, + "com.amazonaws.fsx#RepositoryDnsIps": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#IpAddress" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } } }, "com.amazonaws.fsx#RequestTime": { @@ -6251,33 +7259,37 @@ } }, "com.amazonaws.fsx#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FILE_SYSTEM", - "name": "FILE_SYSTEM" - }, - { - "value": "VOLUME", - "name": "VOLUME" + "type": "enum", + "members": { + "FILE_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_SYSTEM" } - ] + }, + "VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOLUME" + } + } } }, "com.amazonaws.fsx#RestoreOpenZFSVolumeOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DELETE_INTERMEDIATE_SNAPSHOTS", - "name": "DELETE_INTERMEDIATE_SNAPSHOTS" - }, - { - "value": "DELETE_CLONED_VOLUMES", - "name": "DELETE_CLONED_VOLUMES" + "type": "enum", + "members": { + "DELETE_INTERMEDIATE_SNAPSHOTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_INTERMEDIATE_SNAPSHOTS" } - ] + }, + "DELETE_CLONED_VOLUMES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_CLONED_VOLUMES" + } + } } }, "com.amazonaws.fsx#RestoreOpenZFSVolumeOptions": { @@ -6403,7 +7415,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration consists of an AutoImportPolicy that\n defines file events on the data repository are automatically\n imported to the file system and an AutoExportPolicy\n that defines which file events on the file system are automatically\n exported to the data repository. File events are when files or\n directories are added, changed, or deleted on the file system or\n the data repository.
The configuration for an Amazon S3 data repository linked to an\n Amazon FSx for Lustre file system with a data repository association.\n The configuration consists of an AutoImportPolicy that\n defines which file events on the data repository are automatically\n imported to the file system and an AutoExportPolicy that\n defines which file events on the file system are automatically exported\n to the data repository. File events are when files or directories are\n added, changed, or deleted on the file system or the data repository.
Data repository associations on Amazon File Cache don't\n use S3DataRepositoryConfiguration because they don't\n support automatic import or automatic export.
A list of security group IDs.
", + "smithy.api#documentation": "A list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.
", "smithy.api#length": { "min": 0, "max": 50 @@ -6431,22 +7443,26 @@ } }, "com.amazonaws.fsx#SecurityStyle": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNIX", - "name": "UNIX" - }, - { - "value": "NTFS", - "name": "NTFS" - }, - { - "value": "MIXED", - "name": "MIXED" + "type": "enum", + "members": { + "UNIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIX" } - ] + }, + "NTFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NTFS" + } + }, + "MIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIXED" + } + } } }, "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes": { @@ -6562,47 +7578,71 @@ } }, "com.amazonaws.fsx#ServiceLimit": { - "type": "string", + "type": "enum", + "members": { + "FILE_SYSTEM_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_SYSTEM_COUNT" + } + }, + "TOTAL_THROUGHPUT_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_THROUGHPUT_CAPACITY" + } + }, + "TOTAL_STORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_STORAGE" + } + }, + "TOTAL_USER_INITIATED_BACKUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_USER_INITIATED_BACKUPS" + } + }, + "TOTAL_USER_TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_USER_TAGS" + } + }, + "TOTAL_IN_PROGRESS_COPY_BACKUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_IN_PROGRESS_COPY_BACKUPS" + } + }, + "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM" + } + }, + "VOLUMES_PER_FILE_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOLUMES_PER_FILE_SYSTEM" + } + }, + "TOTAL_SSD_IOPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_SSD_IOPS" + } + }, + "FILE_CACHE_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_CACHE_COUNT" + } + } + }, "traits": { - "smithy.api#documentation": "The types of limits on your service utilization. Limits include file system count,\n total throughput capacity, total storage, and total user-initiated backups. These limits\n apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by\n contacting Amazon Web Services Support.
", - "smithy.api#enum": [ - { - "value": "FILE_SYSTEM_COUNT", - "name": "FILE_SYSTEM_COUNT" - }, - { - "value": "TOTAL_THROUGHPUT_CAPACITY", - "name": "TOTAL_THROUGHPUT_CAPACITY" - }, - { - "value": "TOTAL_STORAGE", - "name": "TOTAL_STORAGE" - }, - { - "value": "TOTAL_USER_INITIATED_BACKUPS", - "name": "TOTAL_USER_INITIATED_BACKUPS" - }, - { - "value": "TOTAL_USER_TAGS", - "name": "TOTAL_USER_TAGS" - }, - { - "value": "TOTAL_IN_PROGRESS_COPY_BACKUPS", - "name": "TOTAL_IN_PROGRESS_COPY_BACKUPS" - }, - { - "value": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM", - "name": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM" - }, - { - "value": "VOLUMES_PER_FILE_SYSTEM", - "name": "VOLUMES_PER_FILE_SYSTEM" - }, - { - "value": "TOTAL_SSD_IOPS", - "name": "TOTAL_SSD_IOPS" - } - ] + "smithy.api#documentation": "The types of limits on your service utilization. Limits include file system count,\n total throughput capacity, total storage, and total user-initiated backups. These limits\n apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by\n contacting Amazon Web Services Support.
" } }, "com.amazonaws.fsx#ServiceLimitExceeded": { @@ -6695,18 +7735,20 @@ } }, "com.amazonaws.fsx#SnapshotFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "file-system-id", - "name": "FILE_SYSTEM_ID" - }, - { - "value": "volume-id", - "name": "VOLUME_ID" + "type": "enum", + "members": { + "FILE_SYSTEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-system-id" } - ] + }, + "VOLUME_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume-id" + } + } } }, "com.amazonaws.fsx#SnapshotFilterValue": { @@ -6766,26 +7808,32 @@ } }, "com.amazonaws.fsx#SnapshotLifecycle": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + } } }, "com.amazonaws.fsx#SnapshotName": { @@ -6851,36 +7899,43 @@ "type": "timestamp" }, "com.amazonaws.fsx#Status": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "UPDATED_OPTIMIZING", - "name": "UPDATED_OPTIMIZING" - } - ] + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "UPDATED_OPTIMIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_OPTIMIZING" + } + } } }, "com.amazonaws.fsx#StorageCapacity": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The storage capacity for your Amazon FSx file system, in gibibytes.
", "smithy.api#range": { "min": 0, @@ -6889,19 +7944,23 @@ } }, "com.amazonaws.fsx#StorageType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The storage type for your Amazon FSx file system.
", - "smithy.api#enum": [ - { - "value": "SSD", - "name": "SSD" - }, - { - "value": "HDD", - "name": "HDD" + "type": "enum", + "members": { + "SSD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSD" + } + }, + "HDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HDD" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The storage type for your Amazon FSx file system.
" } }, "com.amazonaws.fsx#StorageVirtualMachine": { @@ -6999,14 +8058,14 @@ } }, "com.amazonaws.fsx#StorageVirtualMachineFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "file-system-id", - "name": "FILE_SYSTEM_ID" + "type": "enum", + "members": { + "FILE_SYSTEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-system-id" } - ] + } } }, "com.amazonaws.fsx#StorageVirtualMachineFilterValue": { @@ -7066,34 +8125,44 @@ } }, "com.amazonaws.fsx#StorageVirtualMachineLifecycle": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "MISCONFIGURED", - "name": "MISCONFIGURED" - }, - { - "value": "PENDING", - "name": "PENDING" - } - ] + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "MISCONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONFIGURED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + } } }, "com.amazonaws.fsx#StorageVirtualMachineName": { @@ -7119,45 +8188,55 @@ } }, "com.amazonaws.fsx#StorageVirtualMachineRootVolumeSecurityStyle": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNIX", - "name": "UNIX" - }, - { - "value": "NTFS", - "name": "NTFS" - }, - { - "value": "MIXED", - "name": "MIXED" + "type": "enum", + "members": { + "UNIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIX" + } + }, + "NTFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NTFS" } - ] + }, + "MIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIXED" + } + } } }, "com.amazonaws.fsx#StorageVirtualMachineSubtype": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "DP_DESTINATION", - "name": "DP_DESTINATION" - }, - { - "value": "SYNC_DESTINATION", - "name": "SYNC_DESTINATION" - }, - { - "value": "SYNC_SOURCE", - "name": "SYNC_SOURCE" - } - ] + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "DP_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DP_DESTINATION" + } + }, + "SYNC_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC_DESTINATION" + } + }, + "SYNC_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC_SOURCE" + } + } } }, "com.amazonaws.fsx#StorageVirtualMachines": { @@ -7172,6 +8251,18 @@ } } }, + "com.amazonaws.fsx#SubDirectoriesPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#Namespace" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, "com.amazonaws.fsx#SubnetId": { "type": "string", "traits": { @@ -7189,7 +8280,7 @@ "target": "com.amazonaws.fsx#SubnetId" }, "traits": { - "smithy.api#documentation": "A list of subnet IDs. Currently, you can specify only one subnet ID in a call to\n the CreateFileSystem operation.
A list of subnet IDs that the cache will be accessible from. You can specify only\n one subnet ID in a call to the CreateFileCache operation.
Updates the configuration of an existing Amazon File Cache resource.\n You can update multiple properties in a single request.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.fsx#UpdateFileCacheLustreConfiguration": { + "type": "structure", + "members": { + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime" + } + }, + "traits": { + "smithy.api#documentation": "The configuration update for an Amazon File Cache resource.
" + } + }, + "com.amazonaws.fsx#UpdateFileCacheRequest": { + "type": "structure", + "members": { + "FileCacheId": { + "target": "com.amazonaws.fsx#FileCacheId", + "traits": { + "smithy.api#documentation": "The ID of the cache that you are updating.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileCacheLustreConfiguration", + "traits": { + "smithy.api#documentation": "The configuration updates for an Amazon File Cache resource.
" + } + } + } + }, + "com.amazonaws.fsx#UpdateFileCacheResponse": { + "type": "structure", + "members": { + "FileCache": { + "target": "com.amazonaws.fsx#FileCache", + "traits": { + "smithy.api#documentation": "A description of the cache that was updated.
" + } + } + } + }, "com.amazonaws.fsx#UpdateFileSystem": { "type": "operation", "input": { @@ -8246,7 +9419,6 @@ "com.amazonaws.fsx#VolumeCapacity": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 2147483647 @@ -8274,18 +9446,20 @@ } }, "com.amazonaws.fsx#VolumeFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "file-system-id", - "name": "FILE_SYSTEM_ID" - }, - { - "value": "storage-virtual-machine-id", - "name": "STORAGE_VIRTUAL_MACHINE_ID" + "type": "enum", + "members": { + "FILE_SYSTEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "file-system-id" + } + }, + "STORAGE_VIRTUAL_MACHINE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "storage-virtual-machine-id" } - ] + } } }, "com.amazonaws.fsx#VolumeFilterValue": { @@ -8345,38 +9519,50 @@ } }, "com.amazonaws.fsx#VolumeLifecycle": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "MISCONFIGURED", - "name": "MISCONFIGURED" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "MISCONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONFIGURED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + } } }, "com.amazonaws.fsx#VolumeName": { @@ -8412,18 +9598,20 @@ } }, "com.amazonaws.fsx#VolumeType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ONTAP", - "name": "ONTAP" - }, - { - "value": "OPENZFS", - "name": "OPENZFS" + "type": "enum", + "members": { + "ONTAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONTAP" + } + }, + "OPENZFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENZFS" } - ] + } } }, "com.amazonaws.fsx#Volumes": { @@ -8461,26 +9649,32 @@ } }, "com.amazonaws.fsx#WindowsAccessAuditLogLevel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "SUCCESS_ONLY", - "name": "SUCCESS_ONLY" - }, - { - "value": "FAILURE_ONLY", - "name": "FAILURE_ONLY" - }, - { - "value": "SUCCESS_AND_FAILURE", - "name": "SUCCESS_AND_FAILURE" - } - ] + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "SUCCESS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS_ONLY" + } + }, + "FAILURE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE_ONLY" + } + }, + "SUCCESS_AND_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS_AND_FAILURE" + } + } } }, "com.amazonaws.fsx#WindowsAuditLogConfiguration": { @@ -8540,22 +9734,26 @@ } }, "com.amazonaws.fsx#WindowsDeploymentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MULTI_AZ_1", - "name": "MULTI_AZ_1" - }, - { - "value": "SINGLE_AZ_1", - "name": "SINGLE_AZ_1" - }, - { - "value": "SINGLE_AZ_2", - "name": "SINGLE_AZ_2" - } - ] + "type": "enum", + "members": { + "MULTI_AZ_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_AZ_1" + } + }, + "SINGLE_AZ_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_AZ_1" + } + }, + "SINGLE_AZ_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_AZ_2" + } + } } }, "com.amazonaws.fsx#WindowsFileSystemConfiguration": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 3e4d26a63a0..4a646e500d9 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -31,21 +31,6 @@ "shapes": { "com.amazonaws.glue#AWSGlue": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Glue", - "arnNamespace": "glue", - "cloudFormationName": "Glue", - "cloudTrailEventSource": "glue.amazonaws.com", - "endpointPrefix": "glue" - }, - "aws.auth#sigv4": { - "name": "glue" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Defines the public endpoint for the Glue service.
", - "smithy.api#title": "AWS Glue" - }, "version": "2017-03-31", "operations": [ { @@ -600,7 +585,22 @@ { "target": "com.amazonaws.glue#UpdateWorkflow" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Glue", + "arnNamespace": "glue", + "cloudFormationName": "Glue", + "cloudTrailEventSource": "glue.amazonaws.com", + "endpointPrefix": "glue" + }, + "aws.auth#sigv4": { + "name": "glue" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Defines the public endpoint for the Glue service.
", + "smithy.api#title": "AWS Glue" + } }, "com.amazonaws.glue#AccessDeniedException": { "type": "structure", @@ -695,70 +695,98 @@ } }, "com.amazonaws.glue#AggFunction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "avg", - "name": "avg" - }, - { - "value": "countDistinct", - "name": "countDistinct" - }, - { - "value": "count", - "name": "count" - }, - { - "value": "first", - "name": "first" - }, - { - "value": "last", - "name": "last" - }, - { - "value": "kurtosis", - "name": "kurtosis" - }, - { - "value": "max", - "name": "max" - }, - { - "value": "min", - "name": "min" - }, - { - "value": "skewness", - "name": "skewness" - }, - { - "value": "stddev_samp", - "name": "stddev_samp" - }, - { - "value": "stddev_pop", - "name": "stddev_pop" - }, - { - "value": "sum", - "name": "sum" - }, - { - "value": "sumDistinct", - "name": "sumDistinct" - }, - { - "value": "var_samp", - "name": "var_samp" - }, - { - "value": "var_pop", - "name": "var_pop" - } - ] + "type": "enum", + "members": { + "avg": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "avg" + } + }, + "countDistinct": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "countDistinct" + } + }, + "count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "count" + } + }, + "first": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "first" + } + }, + "last": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "last" + } + }, + "kurtosis": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kurtosis" + } + }, + "max": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max" + } + }, + "min": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "min" + } + }, + "skewness": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skewness" + } + }, + "stddev_samp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stddev_samp" + } + }, + "stddev_pop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stddev_pop" + } + }, + "sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sum" + } + }, + "sumDistinct": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sumDistinct" + } + }, + "var_samp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "var_samp" + } + }, + "var_pop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "var_pop" + } + } } }, "com.amazonaws.glue#Aggregate": { @@ -931,7 +959,10 @@ } }, "com.amazonaws.glue#AttemptCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#AuditColumnNamesList": { "type": "list", @@ -995,30 +1026,38 @@ } }, "com.amazonaws.glue#BackfillErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENCRYPTED_PARTITION_ERROR", - "name": "ENCRYPTED_PARTITION_ERROR" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "INVALID_PARTITION_TYPE_DATA_ERROR", - "name": "INVALID_PARTITION_TYPE_DATA_ERROR" - }, - { - "value": "MISSING_PARTITION_VALUE_ERROR", - "name": "MISSING_PARTITION_VALUE_ERROR" - }, - { - "value": "UNSUPPORTED_PARTITION_CHARACTER_ERROR", - "name": "UNSUPPORTED_PARTITION_CHARACTER_ERROR" - } - ] + "type": "enum", + "members": { + "ENCRYPTED_PARTITION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTED_PARTITION_ERROR" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "INVALID_PARTITION_TYPE_DATA_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PARTITION_TYPE_DATA_ERROR" + } + }, + "MISSING_PARTITION_VALUE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_PARTITION_VALUE_ERROR" + } + }, + "UNSUPPORTED_PARTITION_CHARACTER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_PARTITION_CHARACTER_ERROR" + } + } } }, "com.amazonaws.glue#BackfillErroredPartitionsList": { @@ -1940,6 +1979,7 @@ "com.amazonaws.glue#BatchSize": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -2210,7 +2250,6 @@ "com.amazonaws.glue#BatchWindow": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 900 @@ -2223,6 +2262,7 @@ "MaximumLength": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size of the longest bit sequence in the column.
", "smithy.api#required": {} } @@ -2230,6 +2270,7 @@ "AverageLength": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The average bit sequence length in the column.
", "smithy.api#required": {} } @@ -2237,6 +2278,7 @@ "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -2430,26 +2472,32 @@ } }, "com.amazonaws.glue#BlueprintRunState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "ROLLING_BACK", - "name": "ROLLING_BACK" - } - ] + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "ROLLING_BACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLING_BACK" + } + } } }, "com.amazonaws.glue#BlueprintRuns": { @@ -2459,26 +2507,32 @@ } }, "com.amazonaws.glue#BlueprintStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.glue#Blueprints": { @@ -2488,7 +2542,10 @@ } }, "com.amazonaws.glue#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.glue#BooleanColumnStatisticsData": { "type": "structure", @@ -2496,6 +2553,7 @@ "NumberOfTrues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of true values in the column.
", "smithy.api#required": {} } @@ -2503,6 +2561,7 @@ "NumberOfFalses": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of false values in the column.
", "smithy.api#required": {} } @@ -2510,6 +2569,7 @@ "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -2520,14 +2580,14 @@ } }, "com.amazonaws.glue#BooleanNullable": { + "type": "boolean" + }, + "com.amazonaws.glue#BooleanValue": { "type": "boolean", "traits": { - "smithy.api#box": {} + "smithy.api#default": false } }, - "com.amazonaws.glue#BooleanValue": { - "type": "boolean" - }, "com.amazonaws.glue#BoundedPartitionValueList": { "type": "list", "member": { @@ -2541,15 +2601,11 @@ } }, "com.amazonaws.glue#BoxedBoolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.glue#BoxedDoubleFraction": { "type": "double", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 1 @@ -2557,15 +2613,11 @@ } }, "com.amazonaws.glue#BoxedLong": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.glue#BoxedNonNegativeInt": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -2574,7 +2626,6 @@ "com.amazonaws.glue#BoxedNonNegativeLong": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -2583,7 +2634,6 @@ "com.amazonaws.glue#BoxedPositiveInt": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -2702,6 +2752,7 @@ "Id": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The ID of the statement to be cancelled.
", "smithy.api#required": {} } @@ -2719,18 +2770,20 @@ "members": {} }, "com.amazonaws.glue#CatalogEncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "SSE-KMS", - "name": "SSEKMS" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "SSEKMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-KMS" } - ] + } } }, "com.amazonaws.glue#CatalogEntries": { @@ -2764,7 +2817,6 @@ "com.amazonaws.glue#CatalogGetterPageSize": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -2787,6 +2839,7 @@ "ImportCompleted": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n True if the migration has completed, or False otherwise.
The amount of time to spend processing each micro batch.
" } }, "DetectSchema": { "target": "com.amazonaws.glue#BoxedBoolean", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" } }, @@ -2881,7 +2932,6 @@ "DetectSchema": { "target": "com.amazonaws.glue#BoxedBoolean", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" } }, @@ -2998,6 +3048,18 @@ "traits": { "smithy.api#documentation": "The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
Return true, if the schema is valid and false otherwise.
" } }, @@ -3137,18 +3200,20 @@ } }, "com.amazonaws.glue#CloudWatchEncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "SSE-KMS", - "name": "SSEKMS" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "SSEKMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-KMS" } - ] + } } }, "com.amazonaws.glue#CodeGenArgName": { @@ -3536,6 +3601,7 @@ "LineNumber": { "target": "com.amazonaws.glue#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The line number of the node.
" } } @@ -3564,6 +3630,7 @@ "Param": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if the value is used as a parameter.
" } } @@ -3837,38 +3904,50 @@ } }, "com.amazonaws.glue#ColumnStatisticsType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BOOLEAN", - "name": "BOOLEAN" - }, - { - "value": "DATE", - "name": "DATE" - }, - { - "value": "DECIMAL", - "name": "DECIMAL" - }, - { - "value": "DOUBLE", - "name": "DOUBLE" - }, - { - "value": "LONG", - "name": "LONG" - }, - { - "value": "STRING", - "name": "STRING" - }, - { - "value": "BINARY", - "name": "BINARY" - } - ] + "type": "enum", + "members": { + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BINARY" + } + } } }, "com.amazonaws.glue#ColumnTypeString": { @@ -3901,84 +3980,108 @@ } }, "com.amazonaws.glue#Comparator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "GREATER_THAN", - "name": "GREATER_THAN" - }, - { - "value": "LESS_THAN", - "name": "LESS_THAN" - }, - { - "value": "GREATER_THAN_EQUALS", - "name": "GREATER_THAN_EQUALS" - }, - { - "value": "LESS_THAN_EQUALS", - "name": "LESS_THAN_EQUALS" - } - ] + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "GREATER_THAN_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_EQUALS" + } + }, + "LESS_THAN_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN_EQUALS" + } + } } }, "com.amazonaws.glue#Compatibility": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "BACKWARD", - "name": "BACKWARD" - }, - { - "value": "BACKWARD_ALL", - "name": "BACKWARD_ALL" - }, - { - "value": "FORWARD", - "name": "FORWARD" - }, - { - "value": "FORWARD_ALL", - "name": "FORWARD_ALL" - }, - { - "value": "FULL", - "name": "FULL" - }, - { - "value": "FULL_ALL", - "name": "FULL_ALL" - } - ] + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "BACKWARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKWARD" + } + }, + "BACKWARD_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKWARD_ALL" + } + }, + "FORWARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORWARD" + } + }, + "FORWARD_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORWARD_ALL" + } + }, + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL" + } + }, + "FULL_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_ALL" + } + } } }, "com.amazonaws.glue#CompressionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "gzip", - "name": "GZIP" - }, - { - "value": "bzip2", - "name": "BZIP2" + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gzip" + } + }, + "BZIP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bzip2" } - ] + } } }, "com.amazonaws.glue#ConcurrentModificationException": { @@ -4241,6 +4344,7 @@ "ReturnConnectionPasswordEncrypted": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When the ReturnConnectionPasswordEncrypted flag is set to \"true\", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.
If the crawler is running, contains the total time elapsed since the last crawl\n began.
" } }, @@ -4645,6 +4830,7 @@ "Version": { "target": "com.amazonaws.glue#VersionId", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of the crawler.
" } }, @@ -4734,6 +4920,7 @@ "DPUHour": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of data processing units (DPU) used in hours for the crawl.
" } } @@ -4749,41 +4936,49 @@ } }, "com.amazonaws.glue#CrawlerHistoryState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.glue#CrawlerLineageSettings": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLE", - "name": "ENABLE" - }, - { - "value": "DISABLE", - "name": "DISABLE" + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE" } - ] + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } } }, "com.amazonaws.glue#CrawlerList": { @@ -4804,42 +4999,49 @@ "TimeLeftSeconds": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The estimated time left to complete a running crawl.
" } }, "StillEstimating": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if the crawler is still estimating how long it will take to complete this run.
" } }, "LastRuntimeSeconds": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration of the crawler's most recent run, in seconds.
" } }, "MedianRuntimeSeconds": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The median duration of this crawler's runs, in seconds.
" } }, "TablesCreated": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of tables created by this crawler.
" } }, "TablesUpdated": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of tables updated by this crawler.
" } }, "TablesDeleted": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of tables deleted by this crawler.
" } } @@ -4920,22 +5122,26 @@ } }, "com.amazonaws.glue#CrawlerState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READY", - "name": "READY" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STOPPING", - "name": "STOPPING" + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" } - ] + } } }, "com.amazonaws.glue#CrawlerStoppingException": { @@ -5378,6 +5584,8 @@ "DisableValueTrimming": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": true, "smithy.api#documentation": "Specifies not to trim values before identifying the type of column values. The default value is true.
" } }, @@ -5608,6 +5816,7 @@ "NumberOfNodes": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of Glue Data Processing Units (DPUs) to allocate to this\n DevEndpoint.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
\n \nFor more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
\n\t \n\tDevelopment endpoints that are created without specifying a Glue version default to Glue 0.9.
\n\t\n\tYou can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The Apache Zeppelin port for the remote Apache Spark interpreter.
" } }, "NumberOfNodes": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
" } }, @@ -5913,12 +6126,14 @@ "MaxRetries": { "target": "com.amazonaws.glue#MaxRetries", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of times to retry this job if it fails.
" } }, "AllocatedCapacity": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, @@ -5928,6 +6143,8 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 2880, "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
" } }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 10, "smithy.api#documentation": "The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.
\n\t\t\n\t\t\t\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
\n MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The version number of the checkpoint (the last time the compatibility mode was changed).
" } }, "LatestSchemaVersion": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The latest version of the schema associated with the returned schema definition.
" } }, "NextSchemaVersion": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The next version of the schema associated with the returned schema definition.
" } }, @@ -7002,6 +7228,7 @@ "StartOnCreation": { "target": "com.amazonaws.glue#BooleanValue", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Set to true to start SCHEDULED and CONDITIONAL\n triggers when created. True is not supported for ON_DEMAND triggers.
The version of this classifier.
" } }, @@ -7293,22 +7521,26 @@ } }, "com.amazonaws.glue#CsvHeaderOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "PRESENT", - "name": "PRESENT" - }, - { - "value": "ABSENT", - "name": "ABSENT" + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "PRESENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESENT" + } + }, + "ABSENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSENT" } - ] + } } }, "com.amazonaws.glue#CsvQuoteSymbol": { @@ -7452,22 +7684,26 @@ } }, "com.amazonaws.glue#DataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVRO", - "name": "AVRO" - }, - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "PROTOBUF", - "name": "PROTOBUF" + "type": "enum", + "members": { + "AVRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVRO" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "PROTOBUF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROTOBUF" } - ] + } } }, "com.amazonaws.glue#DataLakePrincipal": { @@ -7664,6 +7900,7 @@ "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -7671,6 +7908,7 @@ "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of distinct values in a column.
", "smithy.api#required": {} } @@ -7698,6 +7936,7 @@ "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -7705,6 +7944,7 @@ "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of distinct values in a column.
", "smithy.api#required": {} } @@ -7727,6 +7967,7 @@ "Scale": { "target": "com.amazonaws.glue#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The scale that determines where the decimal point falls in the\n unscaled value.
", "smithy.api#required": {} } @@ -7737,22 +7978,26 @@ } }, "com.amazonaws.glue#DeleteBehavior": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LOG", - "name": "LOG" - }, - { - "value": "DELETE_FROM_DATABASE", - "name": "DELETE_FROM_DATABASE" - }, - { - "value": "DEPRECATE_IN_DATABASE", - "name": "DEPRECATE_IN_DATABASE" + "type": "enum", + "members": { + "LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG" + } + }, + "DELETE_FROM_DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FROM_DATABASE" } - ] + }, + "DEPRECATE_IN_DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATE_IN_DATABASE" + } + } } }, "com.amazonaws.glue#DeleteBlueprint": { @@ -9147,6 +9392,7 @@ "ZeppelinRemoteSparkInterpreterPort": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The Apache Zeppelin port for the remote Apache Spark interpreter.
" } }, @@ -9171,6 +9417,8 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "0.9", "smithy.api#documentation": "Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
\n \nFor more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
\n\t \n\tDevelopment endpoints that are created without specifying a Glue version default to Glue 0.9.
\n\t\n\tYou can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
The number of Glue Data Processing Units (DPUs) allocated to this\n DevEndpoint.
The amount of time to spend processing each micro batch.
" } }, "DetectSchema": { "target": "com.amazonaws.glue#BoxedBoolean", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" } }, @@ -9361,14 +9608,12 @@ "WindowSize": { "target": "com.amazonaws.glue#BoxedPositiveInt", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The amount of time to spend processing each micro batch.
" } }, "DetectSchema": { "target": "com.amazonaws.glue#BoxedBoolean", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" } }, @@ -9422,7 +9667,10 @@ } }, "com.amazonaws.glue#Double": { - "type": "double" + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#DoubleColumnStatisticsData": { "type": "structure", @@ -9430,18 +9678,21 @@ "MinimumValue": { "target": "com.amazonaws.glue#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The lowest value in the column.
" } }, "MaximumValue": { "target": "com.amazonaws.glue#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The highest value in the column.
" } }, "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -9449,6 +9700,7 @@ "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of distinct values in a column.
", "smithy.api#required": {} } @@ -9459,7 +9711,10 @@ } }, "com.amazonaws.glue#DoubleValue": { - "type": "double" + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#DropDuplicates": { "type": "structure", @@ -9593,6 +9848,8 @@ "scanAll": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": true, "smithy.api#documentation": "Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
\n\t\n\tA value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
", "smithy.api#required": {} } @@ -9844,18 +10104,22 @@ "type": "string" }, "com.amazonaws.glue#ExecutionClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FLEX", - "name": "FLEX" - }, - { - "value": "STANDARD", - "name": "STANDARD" + "type": "enum", + "members": { + "FLEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEX" } - ], + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + }, + "traits": { "smithy.api#length": { "min": 0, "max": 16 @@ -9868,6 +10132,7 @@ "MaxConcurrentRuns": { "target": "com.amazonaws.glue#MaxConcurrentRuns", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of concurrent runs allowed for the job.\n The default is 1. An error is returned when this threshold is reached.\n The maximum value you can specify is controlled by a service limit.
" } } @@ -9877,25 +10142,32 @@ } }, "com.amazonaws.glue#ExecutionTime": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#ExistCondition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MUST_EXIST", - "name": "MUST_EXIST" - }, - { - "value": "NOT_EXIST", - "name": "NOT_EXIST" - }, - { - "value": "NONE", - "name": "NONE" + "type": "enum", + "members": { + "MUST_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUST_EXIST" + } + }, + "NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EXIST" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" } - ] + } } }, "com.amazonaws.glue#ExportLabelsTaskRunProperties": { @@ -9919,40 +10191,48 @@ } }, "com.amazonaws.glue#FieldName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRAWL_ID", - "name": "CRAWL_ID" - }, - { - "value": "STATE", - "name": "STATE" - }, - { - "value": "START_TIME", - "name": "START_TIME" - }, - { - "value": "END_TIME", - "name": "END_TIME" - }, - { - "value": "DPU_HOUR", - "name": "DPU_HOUR" - } - ] - } - }, - "com.amazonaws.glue#FieldType": { - "type": "string" - }, - "com.amazonaws.glue#FillMissingValues": { - "type": "structure", + "type": "enum", "members": { - "Name": { - "target": "com.amazonaws.glue#NodeName", + "CRAWL_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRAWL_ID" + } + }, + "STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATE" + } + }, + "START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_TIME" + } + }, + "END_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "END_TIME" + } + }, + "DPU_HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DPU_HOUR" + } + } + } + }, + "com.amazonaws.glue#FieldType": { + "type": "string" + }, + "com.amazonaws.glue#FillMissingValues": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { "smithy.api#documentation": "The name of the transform node.
", "smithy.api#required": {} @@ -10054,84 +10334,108 @@ } }, "com.amazonaws.glue#FilterLogicalOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AND", - "name": "AND" - }, - { - "value": "OR", - "name": "OR" + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND" + } + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OR" } - ] + } } }, "com.amazonaws.glue#FilterOperation": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQ", - "name": "EQ" - }, - { - "value": "LT", - "name": "LT" - }, - { - "value": "GT", - "name": "GT" - }, - { - "value": "LTE", - "name": "LTE" - }, - { - "value": "GTE", - "name": "GTE" - }, - { - "value": "REGEX", - "name": "REGEX" - }, - { - "value": "ISNULL", - "name": "ISNULL" - } - ] + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "LTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LTE" + } + }, + "GTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GTE" + } + }, + "REGEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGEX" + } + }, + "ISNULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISNULL" + } + } } }, "com.amazonaws.glue#FilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GT", - "name": "GT" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "LT", - "name": "LT" - }, - { - "value": "LE", - "name": "LE" - }, - { - "value": "EQ", - "name": "EQ" - }, - { - "value": "NE", - "name": "NE" - } - ] + "type": "enum", + "members": { + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" + } + }, + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + } } }, "com.amazonaws.glue#FilterString": { @@ -10167,18 +10471,20 @@ } }, "com.amazonaws.glue#FilterValueType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COLUMNEXTRACTED", - "name": "COLUMNEXTRACTED" - }, - { - "value": "CONSTANT", - "name": "CONSTANT" + "type": "enum", + "members": { + "COLUMNEXTRACTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMNEXTRACTED" + } + }, + "CONSTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONSTANT" } - ] + } } }, "com.amazonaws.glue#FilterValues": { @@ -10311,7 +10617,6 @@ "com.amazonaws.glue#GenericBoundedDouble": { "type": "double", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0.0, "max": 1.0 @@ -10883,6 +11188,7 @@ "HidePassword": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Allows you to retrieve the connection metadata without returning the password. For\n instance, the Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.
" } } @@ -10968,6 +11274,7 @@ "HidePassword": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Allows you to retrieve the connection metadata without returning the password. For\n instance, the Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.
" } }, @@ -11726,6 +12033,7 @@ "PredecessorsIncluded": { "target": "com.amazonaws.glue#BooleanValue", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if a list of predecessor runs should be returned.
" } } @@ -11984,6 +12292,7 @@ "ExecutionTime": { "target": "com.amazonaws.glue#ExecutionTime", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time (in seconds) that the task run consumed resources.
" } } @@ -12171,6 +12480,7 @@ "LabelCount": { "target": "com.amazonaws.glue#LabelCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of labels available for this transform.
" } }, @@ -12189,12 +12499,16 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "0.9", "smithy.api#documentation": "This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
" } }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 10, "smithy.api#documentation": "The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.
\n\t\t\nWhen the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The version number of the checkpoint (the last time the compatibility mode was changed).
" } }, "LatestSchemaVersion": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The latest version of the schema associated with the returned schema definition.
" } }, "NextSchemaVersion": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The next version of the schema associated with the returned schema definition.
" } }, @@ -13228,6 +13547,7 @@ "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the schema.
" } }, @@ -13533,6 +13853,7 @@ "Id": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The Id of the statement.
", "smithy.api#required": {} } @@ -14146,7 +14467,10 @@ "target": "com.amazonaws.glue#NameStringList" }, "IsRegisteredWithLakeFormation": { - "target": "com.amazonaws.glue#Boolean" + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false + } } } }, @@ -14312,7 +14636,10 @@ "target": "com.amazonaws.glue#NameStringList" }, "IsRegisteredWithLakeFormation": { - "target": "com.amazonaws.glue#Boolean" + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false + } }, "CellFilters": { "target": "com.amazonaws.glue#ColumnRowFilterList" @@ -14770,50 +15097,68 @@ } }, "com.amazonaws.glue#GlueRecordType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DATE", - "name": "DATE" - }, - { - "value": "STRING", - "name": "STRING" - }, - { - "value": "TIMESTAMP", - "name": "TIMESTAMP" - }, - { - "value": "INT", - "name": "INT" - }, - { - "value": "FLOAT", - "name": "FLOAT" - }, - { - "value": "LONG", - "name": "LONG" - }, - { - "value": "BIGDECIMAL", - "name": "BIGDECIMAL" - }, - { - "value": "BYTE", - "name": "BYTE" - }, - { - "value": "SHORT", - "name": "SHORT" - }, - { - "value": "DOUBLE", - "name": "DOUBLE" - } - ] + "type": "enum", + "members": { + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INT" + } + }, + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG" + } + }, + "BIGDECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGDECIMAL" + } + }, + "BYTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE" + } + }, + "SHORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHORT" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + } } }, "com.amazonaws.glue#GlueResourceArn": { @@ -15066,6 +15411,7 @@ "Version": { "target": "com.amazonaws.glue#VersionId", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of this classifier.
" } }, @@ -15224,6 +15570,7 @@ "Replace": { "target": "com.amazonaws.glue#ReplaceBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to overwrite your existing labels.
" } } @@ -15233,11 +15580,15 @@ } }, "com.amazonaws.glue#Integer": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#IntegerFlag": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1 @@ -15245,7 +15596,10 @@ } }, "com.amazonaws.glue#IntegerValue": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#InternalServiceException": { "type": "structure", @@ -15293,7 +15647,10 @@ } }, "com.amazonaws.glue#IsVersionValid": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.glue#JDBCConnectorOptions": { "type": "structure", @@ -15474,356 +15831,436 @@ } }, "com.amazonaws.glue#JDBCDataType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARRAY", - "name": "ARRAY" - }, - { - "value": "BIGINT", - "name": "BIGINT" - }, - { - "value": "BINARY", - "name": "BINARY" - }, - { - "value": "BIT", - "name": "BIT" - }, - { - "value": "BLOB", - "name": "BLOB" - }, - { - "value": "BOOLEAN", - "name": "BOOLEAN" - }, - { - "value": "CHAR", - "name": "CHAR" - }, - { - "value": "CLOB", - "name": "CLOB" - }, - { - "value": "DATALINK", - "name": "DATALINK" - }, - { - "value": "DATE", - "name": "DATE" - }, - { - "value": "DECIMAL", - "name": "DECIMAL" - }, - { - "value": "DISTINCT", - "name": "DISTINCT" - }, - { - "value": "DOUBLE", - "name": "DOUBLE" - }, - { - "value": "FLOAT", - "name": "FLOAT" - }, - { - "value": "INTEGER", - "name": "INTEGER" - }, - { - "value": "JAVA_OBJECT", - "name": "JAVA_OBJECT" - }, - { - "value": "LONGNVARCHAR", - "name": "LONGNVARCHAR" - }, - { - "value": "LONGVARBINARY", - "name": "LONGVARBINARY" - }, - { - "value": "LONGVARCHAR", - "name": "LONGVARCHAR" - }, - { - "value": "NCHAR", - "name": "NCHAR" - }, - { - "value": "NCLOB", - "name": "NCLOB" - }, - { - "value": "NULL", - "name": "NULL" - }, - { - "value": "NUMERIC", - "name": "NUMERIC" - }, - { - "value": "NVARCHAR", - "name": "NVARCHAR" - }, - { - "value": "OTHER", - "name": "OTHER" - }, - { - "value": "REAL", - "name": "REAL" - }, - { - "value": "REF", - "name": "REF" - }, - { - "value": "REF_CURSOR", - "name": "REF_CURSOR" - }, - { - "value": "ROWID", - "name": "ROWID" - }, - { - "value": "SMALLINT", - "name": "SMALLINT" - }, - { - "value": "SQLXML", - "name": "SQLXML" - }, - { - "value": "STRUCT", - "name": "STRUCT" - }, - { - "value": "TIME", - "name": "TIME" - }, - { - "value": "TIME_WITH_TIMEZONE", - "name": "TIME_WITH_TIMEZONE" - }, - { - "value": "TIMESTAMP", - "name": "TIMESTAMP" - }, - { - "value": "TIMESTAMP_WITH_TIMEZONE", - "name": "TIMESTAMP_WITH_TIMEZONE" - }, - { - "value": "TINYINT", - "name": "TINYINT" - }, - { - "value": "VARBINARY", - "name": "VARBINARY" - }, - { - "value": "VARCHAR", - "name": "VARCHAR" - } - ] - } - }, - "com.amazonaws.glue#JDBCDataTypeMapping": { - "type": "map", - "key": { - "target": "com.amazonaws.glue#JDBCDataType" - }, - "value": { - "target": "com.amazonaws.glue#GlueRecordType" - } - }, - "com.amazonaws.glue#JdbcTarget": { - "type": "structure", + "type": "enum", "members": { - "ConnectionName": { - "target": "com.amazonaws.glue#ConnectionName", + "ARRAY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the connection to use to connect to the JDBC target.
" + "smithy.api#enumValue": "ARRAY" } }, - "Path": { - "target": "com.amazonaws.glue#Path", + "BIGINT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The path of the JDBC target.
" + "smithy.api#enumValue": "BIGINT" } }, - "Exclusions": { - "target": "com.amazonaws.glue#PathList", + "BINARY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of glob patterns used to exclude from the crawl.\n For more information, see Catalog Tables with a Crawler.
" + "smithy.api#enumValue": "BINARY" } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a JDBC data store to crawl.
" - } - }, - "com.amazonaws.glue#JdbcTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.glue#JdbcTarget" - } - }, - "com.amazonaws.glue#Job": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", + }, + "BIT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name you assign to this job definition.
" + "smithy.api#enumValue": "BIT" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "BLOB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A description of the job.
" + "smithy.api#enumValue": "BLOB" } }, - "LogUri": { - "target": "com.amazonaws.glue#UriString", + "BOOLEAN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "This field is reserved for future use.
" + "smithy.api#enumValue": "BOOLEAN" } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "CHAR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
" + "smithy.api#enumValue": "CHAR" } }, - "CreatedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "CLOB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time and date that this job definition was created.
" + "smithy.api#enumValue": "CLOB" } }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "DATALINK": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The last point in time when this job definition was modified.
" + "smithy.api#enumValue": "DATALINK" } }, - "ExecutionProperty": { - "target": "com.amazonaws.glue#ExecutionProperty", + "DATE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.
The JobCommand that runs this job.
The default arguments for this job, specified as name-value pairs.
\nYou can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.
\nFor information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
\nFor information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "smithy.api#enumValue": "DISTINCT" } }, - "NonOverridableArguments": { - "target": "com.amazonaws.glue#GenericMap", + "DOUBLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Non-overridable arguments for this job, specified as name-value pairs.
" + "smithy.api#enumValue": "DOUBLE" } }, - "Connections": { - "target": "com.amazonaws.glue#ConnectionsList", + "FLOAT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The connections used for this job.
" + "smithy.api#enumValue": "FLOAT" } }, - "MaxRetries": { - "target": "com.amazonaws.glue#MaxRetries", + "INTEGER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The maximum number of times to retry this job after a JobRun fails.
" + "smithy.api#enumValue": "INTEGER" } }, - "AllocatedCapacity": { - "target": "com.amazonaws.glue#IntegerValue", + "JAVA_OBJECT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#deprecated": { - "message": "This property is deprecated, use MaxCapacity instead." - }, - "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
\n\t " + "smithy.api#enumValue": "JAVA_OBJECT" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "LONGNVARCHAR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\t \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of workers of a defined workerType that are allocated when a job runs.
The name of the SecurityConfiguration structure to be used with this\n job.
Specifies configuration properties of a job notification.
" + "smithy.api#enumValue": "NULL" } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "NUMERIC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
\n \nFor more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
\n\t \n\tJobs that are created without specifying a Glue version default to Glue 0.9.
" + "smithy.api#enumValue": "NUMERIC" } }, - "CodeGenConfigurationNodes": { - "target": "com.amazonaws.glue#CodeGenConfigurationNodes", + "NVARCHAR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
" + "smithy.api#enumValue": "NVARCHAR" } }, - "ExecutionClass": { - "target": "com.amazonaws.glue#ExecutionClass", + "OTHER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
\n\nThe flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
\n\t\n\tOnly jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Specifies a job definition.
" - } - }, - "com.amazonaws.glue#JobBookmarkEntry": { - "type": "structure", - "members": { - "JobName": { + }, + "REAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REAL" + } + }, + "REF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REF" + } + }, + "REF_CURSOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REF_CURSOR" + } + }, + "ROWID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWID" + } + }, + "SMALLINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALLINT" + } + }, + "SQLXML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLXML" + } + }, + "STRUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRUCT" + } + }, + "TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME" + } + }, + "TIME_WITH_TIMEZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME_WITH_TIMEZONE" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "TIMESTAMP_WITH_TIMEZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP_WITH_TIMEZONE" + } + }, + "TINYINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TINYINT" + } + }, + "VARBINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARBINARY" + } + }, + "VARCHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARCHAR" + } + } + } + }, + "com.amazonaws.glue#JDBCDataTypeMapping": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#JDBCDataType" + }, + "value": { + "target": "com.amazonaws.glue#GlueRecordType" + } + }, + "com.amazonaws.glue#JdbcTarget": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection to use to connect to the JDBC target.
" + } + }, + "Path": { + "target": "com.amazonaws.glue#Path", + "traits": { + "smithy.api#documentation": "The path of the JDBC target.
" + } + }, + "Exclusions": { + "target": "com.amazonaws.glue#PathList", + "traits": { + "smithy.api#documentation": "A list of glob patterns used to exclude from the crawl.\n For more information, see Catalog Tables with a Crawler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a JDBC data store to crawl.
" + } + }, + "com.amazonaws.glue#JdbcTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#JdbcTarget" + } + }, + "com.amazonaws.glue#Job": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name you assign to this job definition.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "A description of the job.
" + } + }, + "LogUri": { + "target": "com.amazonaws.glue#UriString", + "traits": { + "smithy.api#documentation": "This field is reserved for future use.
" + } + }, + "Role": { + "target": "com.amazonaws.glue#RoleString", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
" + } + }, + "CreatedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "The time and date that this job definition was created.
" + } + }, + "LastModifiedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "The last point in time when this job definition was modified.
" + } + }, + "ExecutionProperty": { + "target": "com.amazonaws.glue#ExecutionProperty", + "traits": { + "smithy.api#documentation": "An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.
The JobCommand that runs this job.
The default arguments for this job, specified as name-value pairs.
\nYou can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.
\nFor information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
\nFor information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + } + }, + "NonOverridableArguments": { + "target": "com.amazonaws.glue#GenericMap", + "traits": { + "smithy.api#documentation": "Non-overridable arguments for this job, specified as name-value pairs.
" + } + }, + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", + "traits": { + "smithy.api#documentation": "The connections used for this job.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.glue#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of times to retry this job after a JobRun fails.
" + } + }, + "AllocatedCapacity": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#deprecated": { + "message": "This property is deprecated, use MaxCapacity instead." + }, + "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
\n\t " + } + }, + "Timeout": { + "target": "com.amazonaws.glue#Timeout", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 2880, + "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\t \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of workers of a defined workerType that are allocated when a job runs.
The name of the SecurityConfiguration structure to be used with this\n job.
Specifies configuration properties of a job notification.
" + } + }, + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", + "traits": { + "smithy.api#documentation": "Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
\n \nFor more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
\n\t \n\tJobs that are created without specifying a Glue version default to Glue 0.9.
" + } + }, + "CodeGenConfigurationNodes": { + "target": "com.amazonaws.glue#CodeGenConfigurationNodes", + "traits": { + "smithy.api#documentation": "The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
" + } + }, + "ExecutionClass": { + "target": "com.amazonaws.glue#ExecutionClass", + "traits": { + "smithy.api#documentation": "Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
\n\nThe flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
\n\t\n\tOnly jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
Specifies a job definition.
" + } + }, + "com.amazonaws.glue#JobBookmarkEntry": { + "type": "structure", + "members": { + "JobName": { "target": "com.amazonaws.glue#JobName", "traits": { "smithy.api#documentation": "The name of the job in question.
" @@ -15832,18 +16269,21 @@ "Version": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of the job.
" } }, "Run": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The run ID number.
" } }, "Attempt": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The attempt ID number.
" } }, @@ -15891,18 +16331,20 @@ } }, "com.amazonaws.glue#JobBookmarksEncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "CSE-KMS", - "name": "CSEKMS" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "CSEKMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSE-KMS" } - ] + } } }, "com.amazonaws.glue#JobCommand": { @@ -15972,6 +16414,7 @@ "Attempt": { "target": "com.amazonaws.glue#AttemptCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of the attempt to run this job.
" } }, @@ -16038,6 +16481,7 @@ "AllocatedCapacity": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, @@ -16047,6 +16491,7 @@ "ExecutionTime": { "target": "com.amazonaws.glue#ExecutionTime", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time (in seconds) that the job run consumed resources.
" } }, @@ -16122,46 +16567,62 @@ } }, "com.amazonaws.glue#JobRunState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "TIMEOUT", - "name": "TIMEOUT" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "WAITING", - "name": "WAITING" - } - ] + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "WAITING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAITING" + } + } } }, "com.amazonaws.glue#JobUpdate": { @@ -16218,12 +16679,14 @@ "MaxRetries": { "target": "com.amazonaws.glue#MaxRetries", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of times to retry this job if it fails.
" } }, "AllocatedCapacity": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, @@ -16233,6 +16696,8 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 2880, "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).
The version of this classifier.
" } }, @@ -16490,6 +16966,8 @@ "StartingOffsets": { "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "latest", "smithy.api#documentation": "The starting position in the Kafka topic to read data from. The possible values are \"earliest\" or \"latest\". The default value is \"latest\".
The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
The starting position in the Kinesis data stream to read data from. The possible values are \"latest\", \"trim_horizon\", or \"earliest\". The default value is \"latest\".
The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
Adds a time delay between two consecutive getRecords operations. The default value is \"False\". This option is only configurable for Glue version 2.0 and above.
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is \"False\".
The maximum number of results to return. The default is 20, and maximum is 100.
" } }, @@ -17955,33 +18475,38 @@ } }, "com.amazonaws.glue#Logical": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AND", - "name": "AND" - }, - { - "value": "ANY", - "name": "ANY" + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" } - ] + } } }, "com.amazonaws.glue#LogicalOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" } - ] + } } }, "com.amazonaws.glue#Long": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#LongColumnStatisticsData": { "type": "structure", @@ -17989,18 +18514,21 @@ "MinimumValue": { "target": "com.amazonaws.glue#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The lowest value in the column.
" } }, "MaximumValue": { "target": "com.amazonaws.glue#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The highest value in the column.
" } }, "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -18008,6 +18536,7 @@ "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of distinct values in a column.
", "smithy.api#required": {} } @@ -18018,7 +18547,10 @@ } }, "com.amazonaws.glue#LongValue": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.glue#MLTransform": { "type": "structure", @@ -18080,6 +18612,7 @@ "LabelCount": { "target": "com.amazonaws.glue#LabelCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
" } }, @@ -18098,12 +18631,16 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "0.9", "smithy.api#documentation": "This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
" } }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 10, "smithy.api#documentation": "The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.
\n\t\t\n\t\t\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
\n MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
\n\t\n\tA value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Indicates that the column is sorted in ascending order\n (== 1), or in descending order (==0).
The latest version of the schema.
" } }, "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the schema.
" } }, @@ -20258,6 +20846,7 @@ "MaxResults": { "target": "com.amazonaws.glue#QuerySchemaVersionMetadataMaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
" } }, @@ -20272,6 +20861,7 @@ "com.amazonaws.glue#QuerySchemaVersionMetadataMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -20302,51 +20892,58 @@ } }, "com.amazonaws.glue#QuoteChar": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "quote", - "name": "QUOTE" - }, - { - "value": "quillemet", - "name": "QUILLEMET" - }, - { - "value": "single_quote", - "name": "SINGLE_QUOTE" - }, - { - "value": "disabled", - "name": "DISABLED" - } - ] + "type": "enum", + "members": { + "QUOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "quote" + } + }, + "QUILLEMET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "quillemet" + } + }, + "SINGLE_QUOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "single_quote" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } } }, "com.amazonaws.glue#RecordsCount": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.glue#RecrawlBehavior": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRAWL_EVERYTHING", - "name": "CRAWL_EVERYTHING" - }, - { - "value": "CRAWL_NEW_FOLDERS_ONLY", - "name": "CRAWL_NEW_FOLDERS_ONLY" - }, - { - "value": "CRAWL_EVENT_MODE", - "name": "CRAWL_EVENT_MODE" + "type": "enum", + "members": { + "CRAWL_EVERYTHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRAWL_EVERYTHING" + } + }, + "CRAWL_NEW_FOLDERS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRAWL_NEW_FOLDERS_ONLY" + } + }, + "CRAWL_EVENT_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRAWL_EVENT_MODE" } - ] + } } }, "com.amazonaws.glue#RecrawlPolicy": { @@ -20521,6 +21118,7 @@ "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of this schema (for sync flow only, in case this is the first version).
" } }, @@ -20603,18 +21201,20 @@ } }, "com.amazonaws.glue#RegistryStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.glue#RelationalCatalogSource": { @@ -20723,12 +21323,14 @@ "LatestVersion": { "target": "com.amazonaws.glue#LatestSchemaVersionBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "The latest version of the schema.
" } }, "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the schema.
" } }, @@ -20789,7 +21391,10 @@ } }, "com.amazonaws.glue#ReplaceBoolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.glue#ResetJobBookmark": { "type": "operation", @@ -20877,37 +21482,43 @@ } }, "com.amazonaws.glue#ResourceShareType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FOREIGN", - "name": "FOREIGN" - }, - { - "value": "ALL", - "name": "ALL" + "type": "enum", + "members": { + "FOREIGN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOREIGN" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" } - ] + } } }, "com.amazonaws.glue#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JAR", - "name": "JAR" - }, - { - "value": "FILE", - "name": "FILE" - }, - { - "value": "ARCHIVE", - "name": "ARCHIVE" + "type": "enum", + "members": { + "JAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JAR" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE" + } + }, + "ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVE" } - ] + } } }, "com.amazonaws.glue#ResourceUri": { @@ -21104,6 +21715,7 @@ "Id": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Returns the Id of the statement that was run.
" } } @@ -21248,6 +21860,8 @@ "MaxBand": { "target": "com.amazonaws.glue#BoxedNonNegativeInt", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 900000, "smithy.api#documentation": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
" } }, @@ -21266,6 +21880,8 @@ "Separator": { "target": "com.amazonaws.glue#Separator", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "comma", "smithy.api#documentation": "Specifies the delimiter character. The default is a comma: \",\", but any other character can be specified.
", "smithy.api#required": {} } @@ -21273,12 +21889,16 @@ "Escaper": { "target": "com.amazonaws.glue#EnclosedInStringPropertyWithQuote", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "none", "smithy.api#documentation": "Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\\n, \\r, \\t, and \\0).
Specifies the character to use for quoting. The default is a double quote: '\"'. Set this to -1 to turn off quoting entirely.
A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
A Boolean value that specifies whether to treat the first line as a header. The default value is False.
A Boolean value that specifies whether to write the header to output. The default value is True.
A Boolean value that specifies whether to skip the first data line. The default value is False.
A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
" } }, @@ -21437,22 +22066,26 @@ } }, "com.amazonaws.glue#S3EncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "SSE-KMS", - "name": "SSEKMS" - }, - { - "value": "SSE-S3", - "name": "SSES3" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "SSEKMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-KMS" } - ] + }, + "SSES3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-S3" + } + } } }, "com.amazonaws.glue#S3GlueParquetTarget": { @@ -21552,6 +22185,8 @@ "MaxBand": { "target": "com.amazonaws.glue#BoxedNonNegativeInt", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 900000, "smithy.api#documentation": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
" } }, @@ -21576,6 +22211,8 @@ "Multiline": { "target": "com.amazonaws.glue#BoxedBoolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
" } }, @@ -21760,22 +22399,26 @@ } }, "com.amazonaws.glue#ScheduleState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SCHEDULED", - "name": "SCHEDULED" - }, - { - "value": "NOT_SCHEDULED", - "name": "NOT_SCHEDULED" - }, - { - "value": "TRANSITIONING", - "name": "TRANSITIONING" + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" } - ] + }, + "NOT_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SCHEDULED" + } + }, + "TRANSITIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSITIONING" + } + } } }, "com.amazonaws.glue#SchedulerNotRunningException": { @@ -21846,6 +22489,7 @@ "com.amazonaws.glue#SchemaCheckpointNumber": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100000 @@ -21893,14 +22537,14 @@ } }, "com.amazonaws.glue#SchemaDiffType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SYNTAX_DIFF", - "name": "SYNTAX_DIFF" + "type": "enum", + "members": { + "SYNTAX_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNTAX_DIFF" } - ] + } } }, "com.amazonaws.glue#SchemaId": { @@ -22006,7 +22650,7 @@ "SchemaVersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The version number of the schema.
" } } @@ -22029,22 +22673,26 @@ "type": "string" }, "com.amazonaws.glue#SchemaStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.glue#SchemaValidationError": { @@ -22062,6 +22710,7 @@ "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the schema.
" } }, @@ -22116,6 +22765,7 @@ "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the schema.
" } }, @@ -22142,12 +22792,14 @@ "LatestVersion": { "target": "com.amazonaws.glue#LatestSchemaVersionBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "The latest version available for the schema.
" } }, "VersionNumber": { "target": "com.amazonaws.glue#VersionLongNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the schema.
" } } @@ -22157,26 +22809,32 @@ } }, "com.amazonaws.glue#SchemaVersionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "FAILURE", - "name": "FAILURE" - }, - { - "value": "DELETING", - "name": "DELETING" - } - ] + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.glue#ScriptLocationString": { @@ -22336,6 +22994,7 @@ "SegmentNumber": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The zero-based index number of the segment. For example, if the total number of segments\n is 4, SegmentNumber values range from 0 through 3.
The total number of segments.
", "smithy.api#required": {} } @@ -22401,6 +23061,7 @@ "Index": { "target": "com.amazonaws.glue#NonNegativeInt", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The index for the DynamicFrame to be selected.
", "smithy.api#required": {} } @@ -22411,30 +23072,38 @@ } }, "com.amazonaws.glue#Separator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "comma", - "name": "COMMA" - }, - { - "value": "ctrla", - "name": "CTRLA" - }, - { - "value": "pipe", - "name": "PIPE" - }, - { - "value": "semicolon", - "name": "SEMICOLON" - }, - { - "value": "tab", - "name": "TAB" - } - ] + "type": "enum", + "members": { + "COMMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "comma" + } + }, + "CTRLA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ctrla" + } + }, + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pipe" + } + }, + "SEMICOLON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "semicolon" + } + }, + "TAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tab" + } + } } }, "com.amazonaws.glue#SerDeInfo": { @@ -22523,6 +23192,7 @@ "Progress": { "target": "com.amazonaws.glue#DoubleValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The code execution progress of the session.
" } }, @@ -22582,34 +23252,44 @@ } }, "com.amazonaws.glue#SessionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROVISIONING", - "name": "PROVISIONING" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "TIMEOUT", - "name": "TIMEOUT" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] + "type": "enum", + "members": { + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.glue#SkewedInfo": { @@ -22639,18 +23319,20 @@ } }, "com.amazonaws.glue#Sort": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASC", - "name": "ASCENDING" - }, - { - "value": "DESC", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" } - ] + } } }, "com.amazonaws.glue#SortCriteria": { @@ -22686,18 +23368,20 @@ } }, "com.amazonaws.glue#SortDirectionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DESCENDING", - "name": "DESCENDING" - }, - { - "value": "ASCENDING", - "name": "ASCENDING" + "type": "enum", + "members": { + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + }, + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" } - ] + } } }, "com.amazonaws.glue#SparkConnectorSource": { @@ -23206,6 +23890,7 @@ "ReplaceAllLabels": { "target": "com.amazonaws.glue#ReplaceBoolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to overwrite your existing labels.
" } } @@ -23279,6 +23964,7 @@ "AllocatedCapacity": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, @@ -23591,22 +24277,26 @@ } }, "com.amazonaws.glue#StartingPosition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "latest", - "name": "LATEST" - }, - { - "value": "trim_horizon", - "name": "TRIM_HORIZON" - }, - { - "value": "earliest", - "name": "EARLIEST" + "type": "enum", + "members": { + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "latest" + } + }, + "TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trim_horizon" } - ] + }, + "EARLIEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "earliest" + } + } } }, "com.amazonaws.glue#Statement": { @@ -23615,6 +24305,7 @@ "Id": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The ID of the statement.
" } }, @@ -23639,18 +24330,21 @@ "Progress": { "target": "com.amazonaws.glue#DoubleValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The code execution progress.
" } }, "StartedOn": { "target": "com.amazonaws.glue#LongValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The unix time and date that the job definition was started.
" } }, "CompletedOn": { "target": "com.amazonaws.glue#LongValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The unix time and date that the job definition was completed.
" } } @@ -23677,6 +24371,7 @@ "ExecutionCount": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The execution count of the output.
" } }, @@ -23724,34 +24419,44 @@ } }, "com.amazonaws.glue#StatementState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WAITING", - "name": "WAITING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "CANCELLING", - "name": "CANCELLING" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] + "type": "enum", + "members": { + "WAITING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAITING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.glue#StopCrawler": { @@ -24039,12 +24744,14 @@ "Compressed": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n True if the data in the table is compressed, or False if\n not.
Must be specified if the table contains any dimension columns.
" } }, @@ -24081,6 +24788,7 @@ "StoredAsSubDirectories": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n True if the table data is stored in subdirectories, or False if\n not.
The size of the longest string in the column.
", "smithy.api#required": {} } @@ -24128,6 +24837,7 @@ "AverageLength": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The average string length in the column.
", "smithy.api#required": {} } @@ -24135,6 +24845,7 @@ "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of null values in the column.
", "smithy.api#required": {} } @@ -24142,6 +24853,7 @@ "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of distinct values in a column.
", "smithy.api#required": {} } @@ -24212,6 +24924,7 @@ "Retention": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The retention time for this table.
" } }, @@ -24260,6 +24973,7 @@ "IsRegisteredWithLakeFormation": { "target": "com.amazonaws.glue#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the table has been registered with Lake Formation.
" } }, @@ -24375,6 +25089,7 @@ "Retention": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The retention time for this table.
" } }, @@ -24599,30 +25314,38 @@ } }, "com.amazonaws.glue#TargetFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "json", - "name": "JSON" - }, - { - "value": "csv", - "name": "CSV" - }, - { - "value": "avro", - "name": "AVRO" - }, - { - "value": "orc", - "name": "ORC" - }, - { - "value": "parquet", - "name": "PARQUET" - } - ] + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "csv" + } + }, + "AVRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "avro" + } + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "orc" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } } }, "com.amazonaws.glue#TaskRun": { @@ -24685,6 +25408,7 @@ "ExecutionTime": { "target": "com.amazonaws.glue#ExecutionTime", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time (in seconds) that the task run consumed resources.
" } } @@ -24770,22 +25494,26 @@ } }, "com.amazonaws.glue#TaskRunSortColumnType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TASK_RUN_TYPE", - "name": "TASK_RUN_TYPE" - }, - { - "value": "STATUS", - "name": "STATUS" - }, - { - "value": "STARTED", - "name": "STARTED" + "type": "enum", + "members": { + "TASK_RUN_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK_RUN_TYPE" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" } - ] + } } }, "com.amazonaws.glue#TaskRunSortCriteria": { @@ -24811,71 +25539,90 @@ } }, "com.amazonaws.glue#TaskStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "TIMEOUT", - "name": "TIMEOUT" - } - ] + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + } } }, "com.amazonaws.glue#TaskType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EVALUATION", - "name": "EVALUATION" - }, - { - "value": "LABELING_SET_GENERATION", - "name": "LABELING_SET_GENERATION" - }, - { - "value": "IMPORT_LABELS", - "name": "IMPORT_LABELS" - }, - { - "value": "EXPORT_LABELS", - "name": "EXPORT_LABELS" - }, - { - "value": "FIND_MATCHES", - "name": "FIND_MATCHES" - } - ] + "type": "enum", + "members": { + "EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVALUATION" + } + }, + "LABELING_SET_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LABELING_SET_GENERATION" + } + }, + "IMPORT_LABELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_LABELS" + } + }, + "EXPORT_LABELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPORT_LABELS" + } + }, + "FIND_MATCHES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIND_MATCHES" + } + } } }, "com.amazonaws.glue#Timeout": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -24893,7 +25640,6 @@ "com.amazonaws.glue#Topk": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 100 @@ -24903,6 +25649,7 @@ "com.amazonaws.glue#TotalSegmentsInteger": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 10 @@ -24963,6 +25710,8 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "0.9", "smithy.api#documentation": "This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
" } }, @@ -25047,30 +25796,38 @@ } }, "com.amazonaws.glue#TransformSortColumnType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NAME", - "name": "NAME" - }, - { - "value": "TRANSFORM_TYPE", - "name": "TRANSFORM_TYPE" - }, - { - "value": "STATUS", - "name": "STATUS" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "LAST_MODIFIED", - "name": "LAST_MODIFIED" - } - ] + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "TRANSFORM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFORM_TYPE" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "LAST_MODIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED" + } + } } }, "com.amazonaws.glue#TransformSortCriteria": { @@ -25096,33 +25853,37 @@ } }, "com.amazonaws.glue#TransformStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_READY", - "name": "NOT_READY" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "NOT_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_READY" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.glue#TransformType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FIND_MATCHES", - "name": "FIND_MATCHES" + "type": "enum", + "members": { + "FIND_MATCHES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIND_MATCHES" } - ] + } } }, "com.amazonaws.glue#Trigger": { @@ -25220,65 +25981,85 @@ } }, "com.amazonaws.glue#TriggerState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "ACTIVATING", - "name": "ACTIVATING" - }, - { - "value": "ACTIVATED", - "name": "ACTIVATED" - }, - { - "value": "DEACTIVATING", - "name": "DEACTIVATING" - }, - { - "value": "DEACTIVATED", - "name": "DEACTIVATED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.glue#TriggerType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SCHEDULED", - "name": "SCHEDULED" - }, - { - "value": "CONDITIONAL", - "name": "CONDITIONAL" - }, - { - "value": "ON_DEMAND", - "name": "ON_DEMAND" - }, - { - "value": "EVENT", - "name": "EVENT" - } - ] + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "CONDITIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONDITIONAL" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + } } }, "com.amazonaws.glue#TriggerUpdate": { @@ -25367,7 +26148,10 @@ "target": "com.amazonaws.glue#NameStringList" }, "IsRegisteredWithLakeFormation": { - "target": "com.amazonaws.glue#Boolean" + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false + } } } }, @@ -25407,18 +26191,20 @@ } }, "com.amazonaws.glue#UnionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "DISTINCT", - "name": "DISTINCT" + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "DISTINCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT" } - ] + } } }, "com.amazonaws.glue#UntagResource": { @@ -25471,18 +26257,20 @@ "members": {} }, "com.amazonaws.glue#UpdateBehavior": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LOG", - "name": "LOG" - }, - { - "value": "UPDATE_IN_DATABASE", - "name": "UPDATE_IN_DATABASE" + "type": "enum", + "members": { + "LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG" + } + }, + "UPDATE_IN_DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_DATABASE" } - ] + } } }, "com.amazonaws.glue#UpdateBlueprint": { @@ -25554,18 +26342,20 @@ } }, "com.amazonaws.glue#UpdateCatalogBehavior": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UPDATE_IN_DATABASE", - "name": "UPDATE_IN_DATABASE" - }, - { - "value": "LOG", - "name": "LOG" + "type": "enum", + "members": { + "UPDATE_IN_DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_DATABASE" + } + }, + "LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG" } - ] + } } }, "com.amazonaws.glue#UpdateClassifier": { @@ -26056,6 +26846,8 @@ "DisableValueTrimming": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": true, "smithy.api#documentation": "Specifies not to trim values before identifying the type of column values. The default value is true.
" } }, @@ -26197,6 +26989,7 @@ "UpdateEtlLibraries": { "target": "com.amazonaws.glue#BooleanValue", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n True if the list of custom libraries to be loaded in the development endpoint\n needs to be updated, or False if otherwise.
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
" } }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 10, "smithy.api#documentation": "The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.
\n\t\t\nWhen the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
Total number of Actions in the workflow run.
" } }, "TimeoutActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Total number of Actions that timed out.
" } }, "FailedActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Total number of Actions that have failed.
" } }, "StoppedActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Total number of Actions that have stopped.
" } }, "SucceededActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Total number of Actions that have succeeded.
" } }, "RunningActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Total number Actions in running state.
" } }, "ErroredActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates the count of job runs in the ERROR state in the workflow run.
" } }, "WaitingActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates the count of job runs in WAITING state in the workflow run.
" } } @@ -27443,30 +28260,38 @@ } }, "com.amazonaws.glue#WorkflowRunStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.glue#WorkflowRuns": { @@ -27525,6 +28350,7 @@ "Version": { "target": "com.amazonaws.glue#VersionId", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of this classifier.
" } }, diff --git a/codegen/sdk/aws-models/identitystore.json b/codegen/sdk/aws-models/identitystore.json index f09b7c98027..96fd3e091dd 100644 --- a/codegen/sdk/aws-models/identitystore.json +++ b/codegen/sdk/aws-models/identitystore.json @@ -164,7 +164,7 @@ } }, "traits": { - "smithy.api#documentation": "A unique identifier for a user or group that is not the its primary identifier. This value can be\n an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a\n unique GroupDisplayName.
A unique identifier for a user or group that is not the primary identifier. This value can be\n an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a\n unique GroupDisplayName.
The group’s display name value. The length limit is 1,024 characters. This\n value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n line, carriage return, space, and nonbreaking space in this attribute. The characters\n <>;:% are excluded. This value is specified at the time that the\n group is created and stored as an attribute of the group object in the identity\n store.
The group’s display name value. The length limit is 1,024 characters. This\n value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the\n group is created and stored as an attribute of the group object in the identity\n store.
" } }, "ExternalIds": { @@ -1130,7 +1130,7 @@ "AlternateIdentifier": { "target": "com.amazonaws.identitystore#AlternateIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for an identity resource that is not the primary identifier. This value can be\n an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a\n unique GroupDisplayName.
A unique identifier for a user or group that is not the primary identifier. This value can be\n an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a\n unique GroupDisplayName.
A unique identifier for an identity resource that is not the primary identifier.
", + "smithy.api#documentation": "A unique identifier for a user or group that is not the primary identifier. This value can be\n an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a\n unique UserDisplayName.
The group’s display name value. The length limit is 1,024 characters. This\n value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n line, carriage return, space, and nonbreaking space in this attribute. The characters\n <>;:% are excluded. This value is specified at the time the group is\n created and stored as an attribute of the group object in the identity store.
The group’s display name value. The length limit is 1,024 characters. This\n value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is\n created and stored as an attribute of the group object in the identity store.
" } }, "ExternalIds": { @@ -1742,7 +1742,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the attribute name and value of the group that you specified in the search. We\n only support DisplayName as a valid filter attribute path currently, and\n filter is required. This API returns minimum attributes, including GroupId and\n group DisplayName in the response.
Lists all groups in the identity store. Returns a paginated list of complete Group objects. \n Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.
Lists the attribute name and value of the user that you specified in the search. We only\n support UserName as a valid filter attribute path currently, and filter is\n required. This API returns minimum attributes, including UserId and\n UserName in the response.
Lists all users in the identity store. Returns a paginated list of complete User objects. \n Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.
You don't have sufficient permission to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.iotfleetwise#Actuator": { + "type": "structure", + "members": { + "fullyQualifiedName": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The fully qualified name of the actuator. For example, the fully qualified name of an\n actuator might be Vehicle.Front.Left.Door.Lock.
The specified data type of the actuator.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the actuator.
" + } + }, + "unit": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The scientific unit for the actuator.
" + } + }, + "allowedValues": { + "target": "com.amazonaws.iotfleetwise#listOfStrings", + "traits": { + "smithy.api#documentation": "A list of possible values an actuator can take.
" + } + }, + "min": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "The specified possible minimum value of an actuator.
" + } + }, + "max": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "The specified possible maximum value of an actuator.
" + } + }, + "assignedValue": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "A specified value for the actuator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A signal that represents a vehicle device such as the engine, heater, and door locks.\n Data from an actuator reports the state of a certain vehicle device.
\nUpdating actuator data can change the state of a device. For example, you can\n turn on or off the heater by updating its actuator data.
\nAdds, or associates, a vehicle with a fleet.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/vehicles/{vehicleName}/associate", + "code": 204 + } + } + }, + "com.amazonaws.iotfleetwise#AssociateVehicleFleetRequest": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle to associate with the fleet.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The ID of a fleet.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#AssociateVehicleFleetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleetwise#Attribute": { + "type": "structure", + "members": { + "fullyQualifiedName": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The fully qualified name of the attribute. For example, the fully qualified name of an\n attribute might be Vehicle.Body.Engine.Type.
The specified data type of the attribute.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the attribute.
" + } + }, + "unit": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The scientific unit for the attribute.
" + } + }, + "allowedValues": { + "target": "com.amazonaws.iotfleetwise#listOfStrings", + "traits": { + "smithy.api#documentation": "A list of possible values an attribute can be assigned.
" + } + }, + "min": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "The specified possible minimum value of the attribute.
" + } + }, + "max": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "The specified possible maximum value of the attribute.
" + } + }, + "assignedValue": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "A specified value for the attribute.
" + } + }, + "defaultValue": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The default value of the attribute.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A signal that represents static information about the vehicle, such as engine type or\n manufacturing date.
" + } + }, + "com.amazonaws.iotfleetwise#BatchCreateVehicle": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#BatchCreateVehicleRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#BatchCreateVehicleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a group, or batch, of vehicles.
\nYou must specify a decoder manifest and a vehicle model (model manifest) for each\n vehicle.
\nFor more information, see Create multiple\n vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/vehicles", + "code": 200 + } + } + }, + "com.amazonaws.iotfleetwise#BatchCreateVehicleRequest": { + "type": "structure", + "members": { + "vehicles": { + "target": "com.amazonaws.iotfleetwise#createVehicleRequestItems", + "traits": { + "smithy.api#documentation": "A list of information about each vehicle to create. For more information, see the\n API data type.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#BatchCreateVehicleResponse": { + "type": "structure", + "members": { + "vehicles": { + "target": "com.amazonaws.iotfleetwise#createVehicleResponses", + "traits": { + "smithy.api#documentation": "A list of information about a batch of created vehicles. For more information, see\n the API data type.
" + } + }, + "errors": { + "target": "com.amazonaws.iotfleetwise#createVehicleErrors", + "traits": { + "smithy.api#documentation": "A list of information about creation errors, or an empty list if there aren't any\n errors.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#BatchUpdateVehicle": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#BatchUpdateVehicleRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#BatchUpdateVehicleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a group, or batch, of vehicles.
\nYou must specify a decoder manifest and a vehicle model (model manifest) for each\n vehicle.
\nFor more information, see Update multiple\n vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/vehicles", + "code": 200 + } + } + }, + "com.amazonaws.iotfleetwise#BatchUpdateVehicleRequest": { + "type": "structure", + "members": { + "vehicles": { + "target": "com.amazonaws.iotfleetwise#updateVehicleRequestItems", + "traits": { + "smithy.api#documentation": "A list of information about the vehicles to update. For more information, see the\n API data type.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#BatchUpdateVehicleResponse": { + "type": "structure", + "members": { + "vehicles": { + "target": "com.amazonaws.iotfleetwise#updateVehicleResponseItems", + "traits": { + "smithy.api#documentation": "A list of information about the batch of updated vehicles.
\nThis list contains only unique IDs for the vehicles that were updated.
\nA list of information about errors returned while updating a batch of vehicles, or, if\n there aren't any errors, an empty list.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#Branch": { + "type": "structure", + "members": { + "fullyQualifiedName": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The fully qualified name of the branch. For example, the fully qualified name of a\n branch might be Vehicle.Body.Engine.
A brief description of the branch.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A group of signals that are defined in a hierarchical structure.
" + } + }, + "com.amazonaws.iotfleetwise#CampaignResource": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName" + } + }, + "put": { + "target": "com.amazonaws.iotfleetwise#CreateCampaign" + }, + "read": { + "target": "com.amazonaws.iotfleetwise#GetCampaign" + }, + "update": { + "target": "com.amazonaws.iotfleetwise#UpdateCampaign" + }, + "delete": { + "target": "com.amazonaws.iotfleetwise#DeleteCampaign" + }, + "list": { + "target": "com.amazonaws.iotfleetwise#ListCampaigns" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Campaign" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.iotfleetwise#CampaignStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "WAITING_FOR_APPROVAL", + "name": "WAITING_FOR_APPROVAL" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SUSPENDED", + "name": "SUSPENDED" + } + ] + } + }, + "com.amazonaws.iotfleetwise#CampaignSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a campaign.
" + } + }, + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of a campaign.
" + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "The description of the campaign.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the signal catalog associated with the campaign.
" + } + }, + "targetArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle or fleet to which the campaign is deployed.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#CampaignStatus", + "traits": { + "smithy.api#documentation": "The state of a campaign. The status can be one of the following:
\n\n CREATING - Amazon Web Services IoT FleetWise is processing your request to create the\n campaign.
\n WAITING_FOR_APPROVAL - After a campaign is created, it enters the\n WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the\n campaign to the target vehicle or fleet, use the API operation to approve the campaign.\n
\n RUNNING - The campaign is active.
\n SUSPENDED - The campaign is suspended. To resume the campaign, use\n the API operation.
The time the campaign was created.
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The last time the campaign was modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a campaign.
\nYou can use the API operation to return this\n information about multiple created campaigns.
" + } + }, + "com.amazonaws.iotfleetwise#CanDbcDefinition": { + "type": "structure", + "members": { + "networkInterface": { + "target": "com.amazonaws.iotfleetwise#InterfaceId", + "traits": { + "smithy.api#documentation": "Contains information about a network interface.
", + "smithy.api#required": {} + } + }, + "canDbcFiles": { + "target": "com.amazonaws.iotfleetwise#NetworkFilesList", + "traits": { + "smithy.api#documentation": "A list of DBC files. You can upload only one DBC file for each network interface and\n specify up to five (inclusive) files in the list.
", + "smithy.api#required": {} + } + }, + "signalsMap": { + "target": "com.amazonaws.iotfleetwise#ModelSignalsMap", + "traits": { + "smithy.api#documentation": "Pairs every signal specified in your vehicle model with a signal decoder.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations used to create a decoder manifest.
" + } + }, + "com.amazonaws.iotfleetwise#CanInterface": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#CanInterfaceName", + "traits": { + "smithy.api#documentation": "The unique name of the interface.
", + "smithy.api#required": {} + } + }, + "protocolName": { + "target": "com.amazonaws.iotfleetwise#ProtocolName", + "traits": { + "smithy.api#documentation": "The name of the communication protocol for the interface.
" + } + }, + "protocolVersion": { + "target": "com.amazonaws.iotfleetwise#ProtocolVersion", + "traits": { + "smithy.api#documentation": "The version of the communication protocol for the interface.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A single controller area network (CAN) device interface.
" + } + }, + "com.amazonaws.iotfleetwise#CanInterfaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iotfleetwise#CanSignal": { + "type": "structure", + "members": { + "messageId": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The ID of the message.
", + "smithy.api#required": {} + } + }, + "isBigEndian": { + "target": "com.amazonaws.iotfleetwise#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the byte ordering of a CAN message is big-endian.
", + "smithy.api#required": {} + } + }, + "isSigned": { + "target": "com.amazonaws.iotfleetwise#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the message data is specified as a signed value.
", + "smithy.api#required": {} + } + }, + "startBit": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Indicates the beginning of the CAN message.
", + "smithy.api#required": {} + } + }, + "offset": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "Indicates where data appears in the CAN message.
", + "smithy.api#required": {} + } + }, + "factor": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "A multiplier used to decode the CAN message.
", + "smithy.api#required": {} + } + }, + "length": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "How many bytes of data are in the message.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.iotfleetwise#CanSignalName", + "traits": { + "smithy.api#documentation": "The name of the signal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a single controller area network (CAN) signal and the messages it\n receives and transmits.
" + } + }, + "com.amazonaws.iotfleetwise#CanSignalName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iotfleetwise#CloudWatchLogDeliveryOptions": { + "type": "structure", + "members": { + "logType": { + "target": "com.amazonaws.iotfleetwise#LogType", + "traits": { + "smithy.api#documentation": "The type of log to send data to Amazon CloudWatch Logs.
", + "smithy.api#required": {} + } + }, + "logGroupName": { + "target": "com.amazonaws.iotfleetwise#CloudWatchLogGroupName", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs group the operation sends data to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The log delivery option to send data to Amazon CloudWatch Logs.
" + } + }, + "com.amazonaws.iotfleetwise#CloudWatchLogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_\\/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.iotfleetwise#CollectionScheme": { + "type": "union", + "members": { + "timeBasedCollectionScheme": { + "target": "com.amazonaws.iotfleetwise#TimeBasedCollectionScheme", + "traits": { + "smithy.api#documentation": "Information about a collection scheme that uses a time period to decide how often to\n collect data.
" + } + }, + "conditionBasedCollectionScheme": { + "target": "com.amazonaws.iotfleetwise#ConditionBasedCollectionScheme", + "traits": { + "smithy.api#documentation": "Information about a collection scheme that uses a simple logical expression to\n recognize what data to collect.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies what data to collect and how often or when to collect it.
" + } + }, + "com.amazonaws.iotfleetwise#Compression": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "SNAPPY", + "name": "SNAPPY" + } + ] + } + }, + "com.amazonaws.iotfleetwise#ConditionBasedCollectionScheme": { + "type": "structure", + "members": { + "expression": { + "target": "com.amazonaws.iotfleetwise#eventExpression", + "traits": { + "smithy.api#documentation": "The logical expression used to recognize what data to collect. For example,\n $variable.Vehicle.OutsideAirTemperature >= 105.0.
The minimum duration of time between two triggering events to collect data, in\n milliseconds.
\nIf a signal changes often, you might want to collect data at a slower rate.
\nWhether to collect data for all triggering events (ALWAYS). Specify\n (RISING_EDGE), or specify only when the condition first evaluates to\n false. For example, triggering on \"AirbagDeployed\"; Users aren't interested on\n triggering when the airbag is already exploded; they only care about the change from not\n deployed => deployed.
Specifies the version of the conditional expression language.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a collection scheme that uses a simple logical expression to\n recognize what data to collect.
" + } + }, + "com.amazonaws.iotfleetwise#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The resource on which there are conflicting operations.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The type of resource on which there are conflicting operations..
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request has conflicting operations. This can occur if you're trying to perform\n more than one operation on the same resource at the same time.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iotfleetwise#CreateCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#CreateCampaignRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#CreateCampaignResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software\n running in vehicles uses campaigns to decide how to collect and transfer data to the\n cloud. You create campaigns in the cloud. After you or your team approve campaigns,\n Amazon Web Services IoT FleetWise automatically deploys them to vehicles.
\nFor more information, see Collect and transfer data\n with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/campaigns/{name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#CreateCampaignRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the campaign to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "An optional description of the campaign to help identify its purpose.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.\n
", + "smithy.api#required": {} + } + }, + "targetArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the vehicle or fleet to deploy a campaign to.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If\n it's not specified, 0 is used.
Default: 0\n
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at\n midnight UTC time). Vehicle data won't be collected after the campaign expires.
\nDefault: 253402243200 (December 31, 9999, 00:00:00 UTC)
" + } + }, + "postTriggerCollectionDuration": { + "target": "com.amazonaws.iotfleetwise#uint32", + "traits": { + "smithy.api#documentation": " (Optional) How long (in milliseconds) to collect raw data after a triggering event\n initiates the collection. If it's not specified, 0 is used.
Default: 0\n
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you\n want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not\n specified, OFF is used.
Default: OFF\n
(Optional) Whether to store collected data after a vehicle lost a connection with the\n cloud. After a connection is re-established, the data is automatically forwarded to\n Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the\n cloud, use TO_DISK. If it's not specified, OFF is used.
Default: OFF\n
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you\n don't want to compress the signals, use OFF. If it's not specified,\n SNAPPY is used.
Default: SNAPPY\n
(Optional) A number indicating the priority of one campaign over another campaign for\n a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles\n before any other campaigns. If it's not specified, 0 is used.
Default: 0\n
(Optional) A list of information about signals to collect.
" + } + }, + "collectionScheme": { + "target": "com.amazonaws.iotfleetwise#CollectionScheme", + "traits": { + "smithy.api#documentation": "The data collection scheme associated with the campaign. You can specify a scheme\n that collects data based on time or an event.
", + "smithy.api#required": {} + } + }, + "dataExtraDimensions": { + "target": "com.amazonaws.iotfleetwise#DataExtraDimensionNodePathList", + "traits": { + "smithy.api#documentation": "(Optional) A list of vehicle attributes to associate with a campaign.
\nDefault: An empty array
" + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the campaign.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateCampaignResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the created campaign.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created campaign.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateDecoderManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#CreateDecoderManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#CreateDecoderManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#DecoderManifestValidationException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates the decoder manifest associated with a model manifest. To create a decoder\n manifest, the following must be true:
\nEvery signal decoder has a unique name.
\nEach signal decoder is associated with a network interface.
\nEach network interface has a unique ID.
\nThe signal decoders are specified in the model manifest.
\nThe unique name of the decoder manifest to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the decoder manifest.
" + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vehicle model (model manifest).
", + "smithy.api#required": {} + } + }, + "signalDecoders": { + "target": "com.amazonaws.iotfleetwise#SignalDecoders", + "traits": { + "smithy.api#documentation": "A list of information about signal decoders.
" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.iotfleetwise#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "A list of information about available network interfaces.
" + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the decoder manifest.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateDecoderManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the created decoder manifest.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created decoder manifest.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#CreateFleetRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#CreateFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a fleet that represents a group of vehicles.\n
\nYou must create both a signal catalog and vehicles before you can create a fleet.\n
\nFor more information, see Fleets in the\n Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/fleets/{fleetId}", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#CreateFleetRequest": { + "type": "structure", + "members": { + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The unique ID of the fleet to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the fleet to create.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a signal catalog.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the fleet.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateFleetResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The ID of the created fleet.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created fleet.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateModelManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#CreateModelManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#CreateModelManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidSignalsException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a vehicle model (model manifest) that specifies signals (attributes,\n branches, sensors, and actuators).
\nFor more information, see Vehicle models\n in the Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/model-manifests/{name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#CreateModelManifestRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the vehicle model to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the vehicle model.
" + } + }, + "nodes": { + "target": "com.amazonaws.iotfleetwise#listOfStrings", + "traits": { + "smithy.api#documentation": "A list of nodes, which are a general abstraction of signals.
", + "smithy.api#required": {} + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a signal catalog.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the vehicle model.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateModelManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the created vehicle model.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created vehicle model.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateSignalCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#CreateSignalCatalogRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#CreateSignalCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidNodeException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidSignalsException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a collection of standardized signals that can be reused to create vehicle\n models.
", + "smithy.api#http": { + "method": "POST", + "uri": "/signal-catalogs/{name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#CreateSignalCatalogRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the signal catalog to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the signal catalog.
" + } + }, + "nodes": { + "target": "com.amazonaws.iotfleetwise#Nodes", + "traits": { + "smithy.api#documentation": "A list of information about nodes, which are a general abstraction of signals. For\n more information, see the API data type.
" + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the signal catalog.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateSignalCatalogResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the created signal catalog.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created signal catalog.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateVehicle": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#CreateVehicleRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#CreateVehicleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles\n created from the same vehicle model consist of the same signals inherited from the\n vehicle model.
\nIf you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a\n vehicle and collect data from your thing.
\nFor more information, see Create a vehicle\n (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/vehicles/{vehicleName}", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#CreateVehicleError": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the vehicle with the error.
" + } + }, + "code": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "An HTTP error code.
" + } + }, + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "A description of the HTTP error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP error resulting from creating a vehicle.
" + } + }, + "com.amazonaws.iotfleetwise#CreateVehicleRequest": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name ARN of a vehicle model.
", + "smithy.api#required": {} + } + }, + "decoderManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a decoder manifest.
", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.iotfleetwise#attributesMap", + "traits": { + "smithy.api#documentation": "Static information about a vehicle in a key-value pair. For example:\n \"engineType\" : \"1.3 L R2\"\n
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an\n existing Amazon Web Services IoT thing as a vehicle.
\nDefault: \n
Metadata that can be used to manage the vehicle.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateVehicleRequestItem": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle to create.
", + "smithy.api#required": {} + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the vehicle model (model manifest) to create the vehicle from.
", + "smithy.api#required": {} + } + }, + "decoderManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.\n
", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.iotfleetwise#attributesMap", + "traits": { + "smithy.api#documentation": "Static information about a vehicle in a key-value pair. For example: \"engine\n Type\" : \"v6\"\n
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an\n existing thing as a vehicle.
" + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata which can be used to manage the vehicle.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the vehicle to create.
" + } + }, + "com.amazonaws.iotfleetwise#CreateVehicleResponse": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the created vehicle.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created vehicle.
" + } + }, + "thingArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a created or validated Amazon Web Services IoT thing.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#CreateVehicleResponseItem": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle to create.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the created vehicle.
" + } + }, + "thingArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a created or validated Amazon Web Services IoT thing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a created vehicle.
" + } + }, + "com.amazonaws.iotfleetwise#DataExtraDimensionNodePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#NodePath" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.iotfleetwise#DecoderManifestResource": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName" + } + }, + "put": { + "target": "com.amazonaws.iotfleetwise#CreateDecoderManifest" + }, + "read": { + "target": "com.amazonaws.iotfleetwise#GetDecoderManifest" + }, + "update": { + "target": "com.amazonaws.iotfleetwise#UpdateDecoderManifest" + }, + "delete": { + "target": "com.amazonaws.iotfleetwise#DeleteDecoderManifest" + }, + "list": { + "target": "com.amazonaws.iotfleetwise#ListDecoderManifests" + }, + "operations": [ + { + "target": "com.amazonaws.iotfleetwise#ImportDecoderManifest" + }, + { + "target": "com.amazonaws.iotfleetwise#ListDecoderManifestNetworkInterfaces" + }, + { + "target": "com.amazonaws.iotfleetwise#ListDecoderManifestSignals" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "DecoderManifest" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.iotfleetwise#DecoderManifestSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The name of the decoder manifest.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle model (model manifest) associated with the decoder manifest.\n
" + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle model (model manifest) associated with the decoder\n manifest.
" + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the decoder manifest.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#ManifestStatus", + "traits": { + "smithy.api#documentation": "The state of the decoder manifest. If the status is ACTIVE, the decoder\n manifest can't be edited. If the status is marked DRAFT, you can edit the\n decoder manifest.
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at\n midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the decoder manifest was last updated in seconds since epoch (January 1,\n 1970 at midnight UTC time).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a created decoder manifest. You can use the API operation to return this information about\n multiple decoder manifests.
" + } + }, + "com.amazonaws.iotfleetwise#DecoderManifestValidationException": { + "type": "structure", + "members": { + "invalidSignals": { + "target": "com.amazonaws.iotfleetwise#InvalidSignalDecoders", + "traits": { + "smithy.api#documentation": "The request couldn't be completed because of invalid signals in the request.
" + } + }, + "invalidNetworkInterfaces": { + "target": "com.amazonaws.iotfleetwise#InvalidNetworkInterfaces", + "traits": { + "smithy.api#documentation": "The request couldn't be completed because of invalid network interfaces in the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request couldn't be completed because it contains signal decoders with one or more validation errors.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleetwise#DeleteCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#DeleteCampaignRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#DeleteCampaignResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data collection campaign. Deleting a campaign suspends all data collection\n and removes it from any vehicles.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/campaigns/{name}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#DeleteCampaignRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the campaign to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteCampaignResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the deleted campaign.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted campaign.
\nThe ARN isn’t returned if a campaign doesn’t exist.
\nDeletes a decoder manifest. You can't delete a decoder manifest if it has vehicles\n associated with it.
\nIf the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200\n response with an empty body.
\nThe name of the decoder manifest to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteDecoderManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the deleted decoder manifest.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted decoder manifest.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#DeleteFleetRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#DeleteFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a fleet. Before you delete a fleet, all vehicles must be\n dissociated from the fleet. For more information, see Delete a fleet (AWS\n CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
\nIf the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response\n with an empty body.
\nThe ID of the fleet to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteFleetResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The ID of the deleted fleet.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted fleet.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteModelManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#DeleteModelManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#DeleteModelManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a vehicle model (model manifest).
\nIf the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200\n response with an empty body.
\nThe name of the model manifest to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteModelManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the deleted model manifest.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted model manifest.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteSignalCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#DeleteSignalCatalogRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#DeleteSignalCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a signal catalog.
\nIf the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200\n response with an empty body.
\nThe name of the signal catalog to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteSignalCatalogResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the deleted signal catalog.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted signal catalog.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteVehicle": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#DeleteVehicleRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#DeleteVehicleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a vehicle and removes it from any campaigns.
\nIf the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response\n with an empty body.
\nThe ID of the vehicle to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DeleteVehicleResponse": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the deleted vehicle.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted vehicle.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DiagnosticsMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "SEND_ACTIVE_DTCS", + "name": "SEND_ACTIVE_DTCS" + } + ] + } + }, + "com.amazonaws.iotfleetwise#DisassociateVehicleFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#DisassociateVehicleFleetRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#DisassociateVehicleFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a\n fleet doesn't delete the vehicle.
\nIf the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an\n HTTP 200 response with an empty body.
\nThe unique ID of the vehicle to disassociate from the fleet.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The unique ID of a fleet.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#DisassociateVehicleFleetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleetwise#FleetAssociationResource": { + "type": "resource", + "identifiers": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName" + }, + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId" + } + }, + "list": { + "target": "com.amazonaws.iotfleetwise#ListFleetsForVehicle" + } + }, + "com.amazonaws.iotfleetwise#FleetResource": { + "type": "resource", + "identifiers": { + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId" + } + }, + "put": { + "target": "com.amazonaws.iotfleetwise#CreateFleet" + }, + "read": { + "target": "com.amazonaws.iotfleetwise#GetFleet" + }, + "update": { + "target": "com.amazonaws.iotfleetwise#UpdateFleet" + }, + "delete": { + "target": "com.amazonaws.iotfleetwise#DeleteFleet" + }, + "list": { + "target": "com.amazonaws.iotfleetwise#ListFleets" + }, + "resources": [ + { + "target": "com.amazonaws.iotfleetwise#VehicleAssociationResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Fleet" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.iotfleetwise#FleetSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The unique ID of the fleet.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the fleet.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the fleet.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the signal catalog associated with the fleet.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight\n UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the fleet was last updated in seconds since epoch (January 1, 1970 at\n midnight UTC time).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a fleet.
\nYou can use the API operation to return this\n information about multiple fleets.
" + } + }, + "com.amazonaws.iotfleetwise#FormattedVss": { + "type": "union", + "members": { + "vssJson": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Provides the VSS in JSON format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Vehicle Signal Specification (VSS) is a precise language used to describe and model\n signals in vehicle networks. The JSON file collects signal specificiations in a VSS\n format.
" + } + }, + "com.amazonaws.iotfleetwise#Fqns": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#FullyQualifiedName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.iotfleetwise#FullyQualifiedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + } + } + }, + "com.amazonaws.iotfleetwise#GetCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetCampaignRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetCampaignResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a campaign.
", + "smithy.api#http": { + "method": "GET", + "uri": "/campaigns/{name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetCampaignRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the campaign to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetCampaignResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the campaign.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the campaign.
" + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "The description of the campaign.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a signal catalog.
" + } + }, + "targetArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the vehicle or the fleet targeted by the campaign.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#CampaignStatus", + "traits": { + "smithy.api#documentation": "The state of the campaign. The status can be one of: CREATING,\n WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.\n
The time, in milliseconds, to deliver a campaign after it was approved.
" + } + }, + "expiryTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight\n UTC time). Vehicle data won't be collected after the campaign expires.
" + } + }, + "postTriggerCollectionDuration": { + "target": "com.amazonaws.iotfleetwise#uint32", + "traits": { + "smithy.api#documentation": "How long (in seconds) to collect raw data after a triggering event initiates the\n collection.
" + } + }, + "diagnosticsMode": { + "target": "com.amazonaws.iotfleetwise#DiagnosticsMode", + "traits": { + "smithy.api#documentation": "Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
" + } + }, + "spoolingMode": { + "target": "com.amazonaws.iotfleetwise#SpoolingMode", + "traits": { + "smithy.api#documentation": "Whether to store collected data after a vehicle lost a connection with the cloud.\n After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.\n
" + } + }, + "compression": { + "target": "com.amazonaws.iotfleetwise#Compression", + "traits": { + "smithy.api#documentation": " Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If\n OFF is specified, the signals aren't compressed. If it's not specified,\n SNAPPY is used.
A number indicating the priority of one campaign over another campaign for a certain\n vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any\n other campaigns.
" + } + }, + "signalsToCollect": { + "target": "com.amazonaws.iotfleetwise#SignalInformationList", + "traits": { + "smithy.api#documentation": "Information about a list of signals to collect data on.
" + } + }, + "collectionScheme": { + "target": "com.amazonaws.iotfleetwise#CollectionScheme", + "traits": { + "smithy.api#documentation": "Information about the data collection scheme associated with the campaign.
" + } + }, + "dataExtraDimensions": { + "target": "com.amazonaws.iotfleetwise#DataExtraDimensionNodePathList", + "traits": { + "smithy.api#documentation": "A list of vehicle attributes associated with the campaign.
" + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the campaign was created in seconds since epoch (January 1, 1970 at midnight\n UTC time).
" + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The last time the campaign was modified.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#GetDecoderManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetDecoderManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetDecoderManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a created decoder manifest.
", + "smithy.api#http": { + "method": "GET", + "uri": "/decoder-manifests/{name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetDecoderManifestRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the decoder manifest to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetDecoderManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The name of the decoder manifest.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the decoder manifest.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the decoder manifest.
" + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle model (model manifest) associated with the decoder\n manifest.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#ManifestStatus", + "traits": { + "smithy.api#documentation": " The state of the decoder manifest. If the status is ACTIVE, the decoder\n manifest can't be edited. If the status is marked DRAFT, you can edit the\n decoder manifest.
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetFleetRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a fleet.
", + "smithy.api#http": { + "method": "GET", + "uri": "/fleets/{fleetId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetFleetRequest": { + "type": "structure", + "members": { + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The ID of the fleet to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetFleetResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The ID of the fleet.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the fleet.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the fleet.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a signal catalog associated with the fleet.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the fleet was created in seconds since epoch (January 1, 1970 at midnight\n UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the fleet was last updated, in seconds since epoch (January 1, 1970 at\n midnight UTC time).
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetLoggingOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetLoggingOptionsRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetLoggingOptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the logging options.
", + "smithy.api#http": { + "method": "GET", + "uri": "/loggingOptions", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetLoggingOptionsRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleetwise#GetLoggingOptionsResponse": { + "type": "structure", + "members": { + "cloudWatchLogDelivery": { + "target": "com.amazonaws.iotfleetwise#CloudWatchLogDeliveryOptions", + "traits": { + "smithy.api#documentation": "Returns information about log delivery to Amazon CloudWatch Logs.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetModelManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetModelManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetModelManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a vehicle model (model manifest).
", + "smithy.api#http": { + "method": "GET", + "uri": "/model-manifests/{name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetModelManifestRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the vehicle model to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetModelManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the vehicle model.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vehicle model.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the vehicle model.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the signal catalog associated with the vehicle model.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#ManifestStatus", + "traits": { + "smithy.api#documentation": " The state of the vehicle model. If the status is ACTIVE, the vehicle\n model can't be edited. You can edit the vehicle model if the status is marked\n DRAFT.
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at\n midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The last time the vehicle model was modified.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetRegisterAccountStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetRegisterAccountStatusRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetRegisterAccountStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the status of registering your Amazon Web Services account, IAM, and\n Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services\n Cloud.
\nFor more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
\nThis API operation doesn't require input parameters.
\nThe unique ID of the Amazon Web Services account, provided at account creation.
", + "smithy.api#required": {} + } + }, + "accountStatus": { + "target": "com.amazonaws.iotfleetwise#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of registering your account and resources. The status can be one\n of:
\n\n REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully\n registered.
\n REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration\n request. This process takes approximately five minutes to complete.
\n REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource.\n Try again later.
Information about the registered Amazon Timestream resources or errors, if any.
", + "smithy.api#required": {} + } + }, + "iamRegistrationResponse": { + "target": "com.amazonaws.iotfleetwise#IamRegistrationResponse", + "traits": { + "smithy.api#documentation": "Information about the registered IAM resources or errors, if any.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the account was registered, in seconds since epoch (January 1, 1970 at\n midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time this registration was last updated, in seconds since epoch (January 1, 1970\n at midnight UTC time).
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetSignalCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetSignalCatalogRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetSignalCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a signal catalog.
", + "smithy.api#http": { + "method": "GET", + "uri": "/signal-catalogs/{name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetSignalCatalogRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the signal catalog to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetSignalCatalogResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the signal catalog.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the signal catalog.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the signal catalog.
" + } + }, + "nodeCounts": { + "target": "com.amazonaws.iotfleetwise#NodeCounts", + "traits": { + "smithy.api#documentation": "The total number of network nodes specified in a signal catalog.
" + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The last time the signal catalog was modified.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetVehicle": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetVehicleRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetVehicleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a vehicle.
", + "smithy.api#http": { + "method": "GET", + "uri": "/vehicles/{vehicleName}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetVehicleRequest": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the vehicle to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetVehicleResponse": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the vehicle.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
" + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle model (model manifest) associated with the vehicle.
" + } + }, + "decoderManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a decoder manifest associated with the vehicle.
" + } + }, + "attributes": { + "target": "com.amazonaws.iotfleetwise#attributesMap", + "traits": { + "smithy.api#documentation": "Static information about a vehicle in a key-value pair. For example:
\n\n \"engineType\" : \"1.3 L R2\"\n
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + } + }, + "com.amazonaws.iotfleetwise#GetVehicleStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetVehicleStatusRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetVehicleStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the status of a vehicle with any associated campaigns.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/vehicles/{vehicleName}/status", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "campaigns" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetVehicleStatusRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the vehicle to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#GetVehicleStatusResponse": { + "type": "structure", + "members": { + "campaigns": { + "target": "com.amazonaws.iotfleetwise#VehicleStatusList", + "traits": { + "smithy.api#documentation": "Lists information about the state of the vehicle with deployed campaigns.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
The Amazon Resource Name (ARN) of the IAM role to register.
", + "smithy.api#required": {} + } + }, + "registrationStatus": { + "target": "com.amazonaws.iotfleetwise#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of registering your IAM resource. The status can be one of\n REGISTRATION_SUCCESS, REGISTRATION_PENDING,\n REGISTRATION_FAILURE.
A message associated with a registration error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent\n software can transfer your vehicle data to Amazon Timestream.
" + } + }, + "com.amazonaws.iotfleetwise#IamResources": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.iotfleetwise#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to\n Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.\n
The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to\n Amazon Timestream.
\nFor more information, see IAM roles in the\n Identity and Access Management User Guide.
" + } + }, + "com.amazonaws.iotfleetwise#ImportDecoderManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#ImportDecoderManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#ImportDecoderManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#DecoderManifestValidationException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidSignalsException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a decoder manifest using your existing CAN DBC file from your local device.\n
", + "smithy.api#http": { + "method": "PUT", + "uri": "/decoder-manifests/{name}", + "code": 200 + } + } + }, + "com.amazonaws.iotfleetwise#ImportDecoderManifestRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the decoder manifest to import.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "networkFileDefinitions": { + "target": "com.amazonaws.iotfleetwise#NetworkFileDefinitions", + "traits": { + "smithy.api#documentation": "The file to load into an Amazon Web Services account.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#ImportDecoderManifestResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the imported decoder manifest.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the decoder manifest that was imported.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#ImportSignalCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#ImportSignalCatalogRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#ImportSignalCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidSignalsException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a signal catalog using your existing VSS formatted content from your local\n device.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/signal-catalogs/{name}/nodes", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#ImportSignalCatalogRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the signal catalog to import.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the signal catalog.
" + } + }, + "vss": { + "target": "com.amazonaws.iotfleetwise#FormattedVss", + "traits": { + "smithy.api#documentation": "The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise\n language used to describe and model signals in vehicle networks.
" + } + }, + "tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the signal catalog.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#ImportSignalCatalogResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the imported signal catalog.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the imported signal catalog.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#InterfaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.iotfleetwise#InterfaceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#InterfaceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.iotfleetwise#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.iotfleetwise#RetryAfterSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of seconds to wait before retrying the command.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request couldn't be completed because the server temporarily failed.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iotfleetwise#InvalidNetworkInterface": { + "type": "structure", + "members": { + "interfaceId": { + "target": "com.amazonaws.iotfleetwise#InterfaceId", + "traits": { + "smithy.api#documentation": "The ID of the interface that isn't valid.
" + } + }, + "reason": { + "target": "com.amazonaws.iotfleetwise#NetworkInterfaceFailureReason", + "traits": { + "smithy.api#documentation": "A message about why the interface isn't valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reason a vehicle network interface isn't valid.
" + } + }, + "com.amazonaws.iotfleetwise#InvalidNetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#InvalidNetworkInterface" + } + }, + "com.amazonaws.iotfleetwise#InvalidNodeException": { + "type": "structure", + "members": { + "invalidNodes": { + "target": "com.amazonaws.iotfleetwise#Nodes", + "traits": { + "smithy.api#documentation": "The specified node type isn't valid.
" + } + }, + "reason": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The reason the node validation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified node type doesn't match the expected node type for a node. You can\n specify the node type as branch, sensor, actuator, or attribute.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleetwise#InvalidSignal": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#FullyQualifiedName", + "traits": { + "smithy.api#documentation": "The name of the signal that isn't valid.
" + } + }, + "reason": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "A message about why the signal isn't valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reason that a signal isn't valid.
" + } + }, + "com.amazonaws.iotfleetwise#InvalidSignalDecoder": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#FullyQualifiedName", + "traits": { + "smithy.api#documentation": "The name of a signal decoder that isn't valid.
" + } + }, + "reason": { + "target": "com.amazonaws.iotfleetwise#SignalDecoderFailureReason", + "traits": { + "smithy.api#documentation": "A message about why the signal decoder isn't valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reason that a signal decoder isn't valid.
" + } + }, + "com.amazonaws.iotfleetwise#InvalidSignalDecoders": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#InvalidSignalDecoder" + } + }, + "com.amazonaws.iotfleetwise#InvalidSignals": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#InvalidSignal" + } + }, + "com.amazonaws.iotfleetwise#InvalidSignalsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string" + }, + "invalidSignals": { + "target": "com.amazonaws.iotfleetwise#InvalidSignals", + "traits": { + "smithy.api#documentation": "The signals which caused the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request couldn't be completed because it contains signals that aren't valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleetwise#IoTAutobahnControlPlane": { + "type": "service", + "version": "2021-06-17", + "operations": [ + { + "target": "com.amazonaws.iotfleetwise#BatchCreateVehicle" + }, + { + "target": "com.amazonaws.iotfleetwise#BatchUpdateVehicle" + }, + { + "target": "com.amazonaws.iotfleetwise#GetLoggingOptions" + }, + { + "target": "com.amazonaws.iotfleetwise#GetRegisterAccountStatus" + }, + { + "target": "com.amazonaws.iotfleetwise#GetVehicleStatus" + }, + { + "target": "com.amazonaws.iotfleetwise#ListTagsForResource" + }, + { + "target": "com.amazonaws.iotfleetwise#PutLoggingOptions" + }, + { + "target": "com.amazonaws.iotfleetwise#RegisterAccount" + }, + { + "target": "com.amazonaws.iotfleetwise#TagResource" + }, + { + "target": "com.amazonaws.iotfleetwise#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.iotfleetwise#CampaignResource" + }, + { + "target": "com.amazonaws.iotfleetwise#DecoderManifestResource" + }, + { + "target": "com.amazonaws.iotfleetwise#FleetResource" + }, + { + "target": "com.amazonaws.iotfleetwise#ModelManifestResource" + }, + { + "target": "com.amazonaws.iotfleetwise#SignalCatalogResource" + }, + { + "target": "com.amazonaws.iotfleetwise#VehicleResource" + } + ], + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "IoTFleetWise", + "arnNamespace": "iotfleetwise" + }, + "aws.auth#sigv4": { + "name": "iotfleetwise" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "Amazon Web Services IoT FleetWise is in preview release and is subject to change. We recommend that you\n use the service only with test data, and not in production environments.
\nWhile Amazon Web Services IoT FleetWise is in preview, you must download the preview Amazon Web Services SDK and CLI\n to use the API operations for this service. These API operations aren't\n available in the public Amazon Web Services SDK or CLI. For more information, see Preview Amazon Web Services SDK\n and CLI in the Amazon Web Services IoT FleetWise Developer Guide.
\nAmazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer\n vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of\n your vehicle data models, independent of the in-vehicle communication architecture, and\n define data collection rules to transfer only high-value data to the cloud.\n
\nFor more information, see What is Amazon Web Services IoT FleetWise? in the\n Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#title": "AWS IoT FleetWise" + } + }, + "com.amazonaws.iotfleetwise#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The identifier of the resource that was exceeded.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The type of resource that was exceeded.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A service quota was exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleetwise#ListCampaigns": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#ListCampaignsRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#ListCampaignsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists information about created campaigns.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#status", + "traits": { + "smithy.api#documentation": "Optional parameter to filter the results by the status of each created campaign in\n your account. The status can be one of: CREATING,\n WAITING_FOR_APPROVAL, RUNNING, or\n SUSPENDED.
A summary of information about each campaign.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Lists the network interfaces specified in a decoder manifest.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The name of the decoder manifest to list information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListDecoderManifestNetworkInterfacesResponse": { + "type": "structure", + "members": { + "networkInterfaces": { + "target": "com.amazonaws.iotfleetwise#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "A list of information about network interfaces.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
A list of information about signal decoders specified in a decoder manifest.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The name of the decoder manifest to list information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListDecoderManifestSignalsResponse": { + "type": "structure", + "members": { + "signalDecoders": { + "target": "com.amazonaws.iotfleetwise#SignalDecoders", + "traits": { + "smithy.api#documentation": "Information about a list of signals to decode.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Lists decoder manifests.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with\n the decoder manifest.
", + "smithy.api#httpQuery": "modelManifestArn" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListDecoderManifestsResponse": { + "type": "structure", + "members": { + "summaries": { + "target": "com.amazonaws.iotfleetwise#decoderManifestSummaries", + "traits": { + "smithy.api#documentation": "A list of information about each decoder manifest.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Retrieves information for each created fleet in an Amazon Web Services account.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Retrieves a list of IDs for all fleets that the vehicle is associated with.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The ID of the vehicle to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListFleetsForVehicleResponse": { + "type": "structure", + "members": { + "fleets": { + "target": "com.amazonaws.iotfleetwise#fleets", + "traits": { + "smithy.api#documentation": "A list of fleet IDs that the vehicle is associated with.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListFleetsResponse": { + "type": "structure", + "members": { + "fleetSummaries": { + "target": "com.amazonaws.iotfleetwise#fleetSummaries", + "traits": { + "smithy.api#documentation": "A list of information for each fleet.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Lists information about nodes specified in a vehicle model (model manifest).
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The name of the vehicle model to list information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListModelManifestNodesResponse": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.iotfleetwise#Nodes", + "traits": { + "smithy.api#documentation": "A list of information about nodes.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Retrieves a list of vehicle models (model manifests).
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models\n associated with it are returned.
", + "smithy.api#httpQuery": "signalCatalogArn" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListModelManifestsResponse": { + "type": "structure", + "members": { + "summaries": { + "target": "com.amazonaws.iotfleetwise#modelManifestSummaries", + "traits": { + "smithy.api#documentation": "A list of information about vehicle models.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Lists of information about the signals (nodes) specified in a signal catalog.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The name of the signal catalog to list information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListSignalCatalogNodesResponse": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.iotfleetwise#Nodes", + "traits": { + "smithy.api#documentation": "A list of information about nodes.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Lists all the created signal catalogs in an Amazon Web Services account.
\nYou can use to list information about\n each signal (node) specified in a signal catalog.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListSignalCatalogsResponse": { + "type": "structure", + "members": { + "summaries": { + "target": "com.amazonaws.iotfleetwise#signalCatalogSummaries", + "traits": { + "smithy.api#documentation": "A list of information about each signal catalog.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
Lists the tags (metadata) you have assigned to the resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.iotfleetwise#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "The list of tags assigned to the resource.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListVehicles": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#ListVehiclesRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#ListVehiclesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of summaries of created vehicles.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Retrieves a list of summaries of all vehicles associated with a fleet.
\nThis API operation uses pagination. Specify the nextToken parameter in the request to return more results.
The ID of a fleet.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListVehiclesInFleetResponse": { + "type": "structure", + "members": { + "vehicles": { + "target": "com.amazonaws.iotfleetwise#vehicles", + "traits": { + "smithy.api#documentation": "A list of vehicles associated with the fleet.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional\n parameter to list only the vehicles created from a certain vehicle model.
", + "smithy.api#httpQuery": "modelManifestArn" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
\nIf the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotfleetwise#ListVehiclesResponse": { + "type": "structure", + "members": { + "vehicleSummaries": { + "target": "com.amazonaws.iotfleetwise#vehicleSummaries", + "traits": { + "smithy.api#documentation": "A list of vehicles and information about them.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iotfleetwise#nextToken", + "traits": { + "smithy.api#documentation": " The token to retrieve the next set of results, or null if there are no more results.
The name of the vehicle model.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vehicle model.
" + } + }, + "signalCatalogArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the signal catalog associated with the vehicle model.
" + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the vehicle model.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#ManifestStatus", + "traits": { + "smithy.api#documentation": "The state of the vehicle model. If the status is ACTIVE, the vehicle\n model can't be edited. If the status is DRAFT, you can edit the vehicle\n model.
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at\n midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the vehicle model was last updated, in seconds since epoch (January 1, 1970\n at midnight UTC time).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a vehicle model (model manifest). You can use the API operation to return this information about\n multiple vehicle models.
" + } + }, + "com.amazonaws.iotfleetwise#ModelSignalsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iotfleetwise#string" + }, + "value": { + "target": "com.amazonaws.iotfleetwise#string" + } + }, + "com.amazonaws.iotfleetwise#NetworkFileBlob": { + "type": "blob" + }, + "com.amazonaws.iotfleetwise#NetworkFileDefinition": { + "type": "union", + "members": { + "canDbc": { + "target": "com.amazonaws.iotfleetwise#CanDbcDefinition", + "traits": { + "smithy.api#documentation": "Information, including CAN DBC files, about the configurations used to create a\n decoder manifest.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifications for defining a vehicle network.
" + } + }, + "com.amazonaws.iotfleetwise#NetworkFileDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#NetworkFileDefinition" + } + }, + "com.amazonaws.iotfleetwise#NetworkFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#NetworkFileBlob" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.iotfleetwise#NetworkInterface": { + "type": "structure", + "members": { + "interfaceId": { + "target": "com.amazonaws.iotfleetwise#InterfaceId", + "traits": { + "smithy.api#documentation": "The ID of the network interface.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.iotfleetwise#NetworkInterfaceType", + "traits": { + "smithy.api#documentation": "The network protocol for the vehicle. For example, CAN_SIGNAL specifies\n a protocol that defines how data is communicated between electronic control units\n (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic\n data is communicated between ECUs.
Information about a network interface specified by the Controller Area Network (CAN)\n protocol.
" + } + }, + "obdInterface": { + "target": "com.amazonaws.iotfleetwise#ObdInterface", + "traits": { + "smithy.api#documentation": "Information about a network interface specified by the On-board diagnostic (OBD) II\n protocol.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a node and its specifications in an in-vehicle communication network. All\n signal decoders must be associated with a network node.
\nTo return this information about all the network interfaces specified in a decoder\n manifest, use the API\n operation.
" + } + }, + "com.amazonaws.iotfleetwise#NetworkInterfaceFailureReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DUPLICATE_NETWORK_INTERFACE", + "name": "DUPLICATE_INTERFACE" + }, + { + "value": "CONFLICTING_NETWORK_INTERFACE", + "name": "CONFLICTING_NETWORK_INTERFACE" + }, + { + "value": "NETWORK_INTERFACE_TO_ADD_ALREADY_EXISTS", + "name": "NETWORK_INTERFACE_TO_ADD_ALREADY_EXISTS" + }, + { + "value": "CAN_NETWORK_INTERFACE_INFO_IS_NULL", + "name": "CAN_NETWORK_INTERFACE_INFO_IS_NULL" + }, + { + "value": "OBD_NETWORK_INTERFACE_INFO_IS_NULL", + "name": "OBD_NETWORK_INTERFACE_INFO_IS_NULL" + }, + { + "value": "NETWORK_INTERFACE_TO_REMOVE_ASSOCIATED_WITH_SIGNALS", + "name": "NETWORK_INTERFACE_TO_REMOVE_ASSOCIATED_WITH_SIGNALS" + } + ] + } + }, + "com.amazonaws.iotfleetwise#NetworkInterfaceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CAN_INTERFACE", + "name": "CAN_INTERFACE" + }, + { + "value": "OBD_INTERFACE", + "name": "OBD_INTERFACE" + } + ] + } + }, + "com.amazonaws.iotfleetwise#NetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#NetworkInterface" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.iotfleetwise#Node": { + "type": "union", + "members": { + "branch": { + "target": "com.amazonaws.iotfleetwise#Branch", + "traits": { + "smithy.api#documentation": "Information about a node specified as a branch.
\nA group of signals that are defined in a hierarchical structure.
\nInformation about a node specified as an actuator.
\nAn actuator is a digital representation of a vehicle device.
\nInformation about a node specified as an attribute.
\nAn attribute represents static information about a vehicle.
\nA general abstraction of a signal. A node can be specified as an actuator, attribute,\n branch, or sensor.
" + } + }, + "com.amazonaws.iotfleetwise#NodeCounts": { + "type": "structure", + "members": { + "totalNodes": { + "target": "com.amazonaws.iotfleetwise#number", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of nodes in a vehicle network.
" + } + }, + "totalBranches": { + "target": "com.amazonaws.iotfleetwise#number", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of nodes in a vehicle network that represent branches.
" + } + }, + "totalSensors": { + "target": "com.amazonaws.iotfleetwise#number", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of nodes in a vehicle network that represent sensors.
" + } + }, + "totalAttributes": { + "target": "com.amazonaws.iotfleetwise#number", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of nodes in a vehicle network that represent attributes.
" + } + }, + "totalActuators": { + "target": "com.amazonaws.iotfleetwise#number", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of nodes in a vehicle network that represent actuators.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the number of nodes and node types in a vehicle network.
" + } + }, + "com.amazonaws.iotfleetwise#NodeDataType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INT8", + "name": "INT8" + }, + { + "value": "UINT8", + "name": "UINT8" + }, + { + "value": "INT16", + "name": "INT16" + }, + { + "value": "UINT16", + "name": "UINT16" + }, + { + "value": "INT32", + "name": "INT32" + }, + { + "value": "UINT32", + "name": "UINT32" + }, + { + "value": "INT64", + "name": "INT64" + }, + { + "value": "UINT64", + "name": "UINT64" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "FLOAT", + "name": "FLOAT" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "UNIX_TIMESTAMP", + "name": "UNIX_TIMESTAMP" + }, + { + "value": "INT8_ARRAY", + "name": "INT8_ARRAY" + }, + { + "value": "UINT8_ARRAY", + "name": "UINT8_ARRAY" + }, + { + "value": "INT16_ARRAY", + "name": "INT16_ARRAY" + }, + { + "value": "UINT16_ARRAY", + "name": "UINT16_ARRAY" + }, + { + "value": "INT32_ARRAY", + "name": "INT32_ARRAY" + }, + { + "value": "UINT32_ARRAY", + "name": "UINT32_ARRAY" + }, + { + "value": "INT64_ARRAY", + "name": "INT64_ARRAY" + }, + { + "value": "UINT64_ARRAY", + "name": "UINT64_ARRAY" + }, + { + "value": "BOOLEAN_ARRAY", + "name": "BOOLEAN_ARRAY" + }, + { + "value": "FLOAT_ARRAY", + "name": "FLOAT_ARRAY" + }, + { + "value": "DOUBLE_ARRAY", + "name": "DOUBLE_ARRAY" + }, + { + "value": "STRING_ARRAY", + "name": "STRING_ARRAY" + }, + { + "value": "UNIX_TIMESTAMP_ARRAY", + "name": "UNIX_TIMESTAMP_ARRAY" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.iotfleetwise#NodePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" + } + }, + "com.amazonaws.iotfleetwise#NodePaths": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#NodePath" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.iotfleetwise#Nodes": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#Node" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.iotfleetwise#ObdBitmaskLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.iotfleetwise#ObdByteLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.iotfleetwise#ObdInterface": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#ObdInterfaceName", + "traits": { + "smithy.api#documentation": "The name of the interface.
", + "smithy.api#required": {} + } + }, + "requestMessageId": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The ID of the message requesting vehicle data.
", + "smithy.api#required": {} + } + }, + "obdStandard": { + "target": "com.amazonaws.iotfleetwise#ObdStandard", + "traits": { + "smithy.api#documentation": "The standard OBD II PID.
" + } + }, + "pidRequestIntervalSeconds": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number message requests per second.
" + } + }, + "dtcRequestIntervalSeconds": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number message requests per diagnostic trouble code per second.
" + } + }, + "useExtendedIds": { + "target": "com.amazonaws.iotfleetwise#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether to use extended IDs in the message.
" + } + }, + "hasTransmissionEcu": { + "target": "com.amazonaws.iotfleetwise#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the vehicle has a transmission control module (TCM).
" + } + } + }, + "traits": { + "smithy.api#documentation": "A network interface that specifies the On-board diagnostic (OBD) II network protocol.
" + } + }, + "com.amazonaws.iotfleetwise#ObdInterfaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iotfleetwise#ObdSignal": { + "type": "structure", + "members": { + "pidResponseLength": { + "target": "com.amazonaws.iotfleetwise#positiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The length of the requested data.
", + "smithy.api#required": {} + } + }, + "serviceMode": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The mode of operation (diagnostic service) in a message.
", + "smithy.api#required": {} + } + }, + "pid": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The diagnostic code used to request data from a vehicle for this signal.
", + "smithy.api#required": {} + } + }, + "scaling": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "A multiplier used to decode the message.
", + "smithy.api#required": {} + } + }, + "offset": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "Indicates where data appears in the message.
", + "smithy.api#required": {} + } + }, + "startByte": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Indicates the beginning of the message.
", + "smithy.api#required": {} + } + }, + "byteLength": { + "target": "com.amazonaws.iotfleetwise#ObdByteLength", + "traits": { + "smithy.api#documentation": "The length of a message.
", + "smithy.api#required": {} + } + }, + "bitRightShift": { + "target": "com.amazonaws.iotfleetwise#nonNegativeInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of positions to shift bits in the message.
" + } + }, + "bitMaskLength": { + "target": "com.amazonaws.iotfleetwise#ObdBitmaskLength", + "traits": { + "smithy.api#documentation": "The number of bits to mask in a message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about signal messages using the on-board diagnostics (OBD) II protocol in\n a vehicle.
" + } + }, + "com.amazonaws.iotfleetwise#ObdStandard": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.iotfleetwise#ProtocolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.iotfleetwise#ProtocolVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.iotfleetwise#PutLoggingOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#PutLoggingOptionsRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#PutLoggingOptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates the logging option.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/loggingOptions", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#PutLoggingOptionsRequest": { + "type": "structure", + "members": { + "cloudWatchLogDelivery": { + "target": "com.amazonaws.iotfleetwise#CloudWatchLogDeliveryOptions", + "traits": { + "smithy.api#documentation": "Creates or updates the log delivery option to Amazon CloudWatch Logs.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#PutLoggingOptionsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleetwise#RegisterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#RegisterAccountRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#RegisterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can\n transfer your vehicle data to the Amazon Web Services Cloud. For more information, including\n step-by-step procedures, see Setting up\n Amazon Web Services IoT FleetWise.
\nAn Amazon Web Services account is not the same thing as a \"user\n account\". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and\n takes the form of either an IAM user or an IAM role, both\n with credentials. A single Amazon Web Services account can, and typically does,\n contain many users and roles.
\nThe IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#RegisterAccountResponse": { + "type": "structure", + "members": { + "registerAccountStatus": { + "target": "com.amazonaws.iotfleetwise#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of registering your Amazon Web Services account, IAM role, and Timestream resources.\n
", + "smithy.api#required": {} + } + }, + "timestreamResources": { + "target": "com.amazonaws.iotfleetwise#TimestreamResources", + "traits": { + "smithy.api#required": {} + } + }, + "iamResources": { + "target": "com.amazonaws.iotfleetwise#IamResources", + "traits": { + "smithy.api#documentation": "The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the account was registered, in seconds since epoch (January 1, 1970 at\n midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time this registration was last updated, in seconds since epoch (January 1, 1970\n at midnight UTC time).
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#RegistrationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REGISTRATION_PENDING", + "name": "REGISTRATION_PENDING" + }, + { + "value": "REGISTRATION_SUCCESS", + "name": "REGISTRATION_SUCCESS" + }, + { + "value": "REGISTRATION_FAILURE", + "name": "REGISTRATION_FAILURE" + } + ] + } + }, + "com.amazonaws.iotfleetwise#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The identifier of the resource that wasn't found.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The type of resource that wasn't found.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The resource wasn't found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iotfleetwise#RetryAfterSeconds": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.iotfleetwise#Sensor": { + "type": "structure", + "members": { + "fullyQualifiedName": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The fully qualified name of the sensor. For example, the fully qualified name of a\n sensor might be Vehicle.Body.Engine.Battery.
The specified data type of the sensor.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of a sensor.
" + } + }, + "unit": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The scientific unit of measurement for data collected by the sensor.
" + } + }, + "allowedValues": { + "target": "com.amazonaws.iotfleetwise#listOfStrings", + "traits": { + "smithy.api#documentation": "A list of possible values a sensor can take.
" + } + }, + "min": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "The specified possible minimum value of the sensor.
" + } + }, + "max": { + "target": "com.amazonaws.iotfleetwise#double", + "traits": { + "smithy.api#documentation": "The specified possible maximum value of the sensor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An input component that reports the environmental condition of a vehicle.
\nYou can collect data about fluid levels, temperatures, vibrations, or battery\n voltage from sensors.
\nThe name of the signal catalog.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the signal catalog.
" + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a collection of standardized signals, which can be attributes,\n branches, sensors, or actuators.
" + } + }, + "com.amazonaws.iotfleetwise#SignalDecoder": { + "type": "structure", + "members": { + "fullyQualifiedName": { + "target": "com.amazonaws.iotfleetwise#FullyQualifiedName", + "traits": { + "smithy.api#documentation": "The fully qualified name of a signal decoder as defined in a vehicle model.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.iotfleetwise#SignalDecoderType", + "traits": { + "smithy.api#documentation": "The network protocol for the vehicle. For example, CAN_SIGNAL specifies\n a protocol that defines how data is communicated between electronic control units\n (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic\n data is communicated between ECUs.
The ID of a network interface that specifies what network protocol a vehicle follows.
", + "smithy.api#required": {} + } + }, + "canSignal": { + "target": "com.amazonaws.iotfleetwise#CanSignal", + "traits": { + "smithy.api#documentation": "Information about signal decoder using the Controller Area Network (CAN) protocol.
" + } + }, + "obdSignal": { + "target": "com.amazonaws.iotfleetwise#ObdSignal", + "traits": { + "smithy.api#documentation": "Information about signal decoder using the On-board diagnostic (OBD) II protocol.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a signal decoder.
" + } + }, + "com.amazonaws.iotfleetwise#SignalDecoderFailureReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DUPLICATE_SIGNAL", + "name": "DUPLICATE_SIGNAL" + }, + { + "value": "CONFLICTING_SIGNAL", + "name": "CONFLICTING_SIGNAL" + }, + { + "value": "SIGNAL_TO_ADD_ALREADY_EXISTS", + "name": "SIGNAL_TO_ADD_ALREADY_EXISTS" + }, + { + "value": "SIGNAL_NOT_ASSOCIATED_WITH_NETWORK_INTERFACE", + "name": "SIGNAL_NOT_ASSOCIATED_WITH_NETWORK_INTERFACE" + }, + { + "value": "NETWORK_INTERFACE_TYPE_INCOMPATIBLE_WITH_SIGNAL_DECODER_TYPE", + "name": "NETWORK_INTERFACE_TYPE_INCOMPATIBLE_WITH_SIGNAL_DECODER_TYPE" + }, + { + "value": "SIGNAL_NOT_IN_MODEL", + "name": "SIGNAL_NOT_IN_MODEL" + }, + { + "value": "CAN_SIGNAL_INFO_IS_NULL", + "name": "CAN_SIGNAL_INFO_IS_NULL" + }, + { + "value": "OBD_SIGNAL_INFO_IS_NULL", + "name": "OBD_SIGNAL_INFO_IS_NULL" + }, + { + "value": "NO_DECODER_INFO_FOR_SIGNAL_IN_MODEL", + "name": "NO_DECODER_INFO_FOR_SIGNAL_IN_MODEL" + } + ] + } + }, + "com.amazonaws.iotfleetwise#SignalDecoderType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CAN_SIGNAL", + "name": "CAN_SIGNAL" + }, + { + "value": "OBD_SIGNAL", + "name": "OBD_SIGNAL" + } + ] + } + }, + "com.amazonaws.iotfleetwise#SignalDecoders": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#SignalDecoder" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.iotfleetwise#SignalInformation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#wildcardSignalName", + "traits": { + "smithy.api#documentation": "The name of the signal.
", + "smithy.api#required": {} + } + }, + "maxSampleCount": { + "target": "com.amazonaws.iotfleetwise#maxSampleCount", + "traits": { + "smithy.api#documentation": "The maximum number of samples to collect.
" + } + }, + "minimumSamplingIntervalMs": { + "target": "com.amazonaws.iotfleetwise#uint32", + "traits": { + "smithy.api#documentation": "The minimum duration of time (in milliseconds) between two triggering events to\n collect data.
\nIf a signal changes often, you might want to collect data at a slower rate.
\nInformation about a signal.
" + } + }, + "com.amazonaws.iotfleetwise#SignalInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#SignalInformation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.iotfleetwise#SpoolingMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "TO_DISK", + "name": "TO_DISK" + } + ] + } + }, + "com.amazonaws.iotfleetwise#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.iotfleetwise#TagKey", + "traits": { + "smithy.api#documentation": "The tag's key.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.iotfleetwise#TagValue", + "traits": { + "smithy.api#documentation": "The tag's value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A set of key/value pairs that are used to manage the resource.
" + } + }, + "com.amazonaws.iotfleetwise#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.iotfleetwise#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.iotfleetwise#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iotfleetwise#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds to or modifies the tags of the given resource. Tags are metadata which can be\n used to manage a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.iotfleetwise#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iotfleetwise#TagList", + "traits": { + "smithy.api#documentation": "The new or modified tags for the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleetwise#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotfleetwise#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#required": {} + } + }, + "quotaCode": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The quota identifier of the applied throttling rules for this request.
" + } + }, + "serviceCode": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The code for the service that couldn't be completed due to throttling.
" + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.iotfleetwise#RetryAfterSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of seconds to wait before retrying the command.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request couldn't be completed due to throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.iotfleetwise#TimeBasedCollectionScheme": { + "type": "structure", + "members": { + "periodMs": { + "target": "com.amazonaws.iotfleetwise#collectionPeriodMs", + "traits": { + "smithy.api#documentation": "The time period (in milliseconds) to decide how often to collect data. For example,\n if the time period is 60000, the Edge Agent software collects data once\n every minute.
Information about a collection scheme that uses a time period to decide how often to\n collect data.
" + } + }, + "com.amazonaws.iotfleetwise#TimestreamDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.iotfleetwise#TimestreamRegistrationResponse": { + "type": "structure", + "members": { + "timestreamDatabaseName": { + "target": "com.amazonaws.iotfleetwise#TimestreamDatabaseName", + "traits": { + "smithy.api#documentation": "The name of the Timestream database.
", + "smithy.api#required": {} + } + }, + "timestreamTableName": { + "target": "com.amazonaws.iotfleetwise#TimestreamTableName", + "traits": { + "smithy.api#documentation": "The name of the Timestream database table.
", + "smithy.api#required": {} + } + }, + "timestreamDatabaseArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Timestream database.
" + } + }, + "timestreamTableArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the Timestream database table.
" + } + }, + "registrationStatus": { + "target": "com.amazonaws.iotfleetwise#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of registering your Amazon Timestream resources. The status can be one of\n REGISTRATION_SUCCESS, REGISTRATION_PENDING,\n REGISTRATION_FAILURE.
A message associated with a registration error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the registered Amazon Timestream resources or errors, if any.
" + } + }, + "com.amazonaws.iotfleetwise#TimestreamResources": { + "type": "structure", + "members": { + "timestreamDatabaseName": { + "target": "com.amazonaws.iotfleetwise#TimestreamDatabaseName", + "traits": { + "smithy.api#documentation": "The name of the registered Amazon Timestream database.
", + "smithy.api#required": {} + } + }, + "timestreamTableName": { + "target": "com.amazonaws.iotfleetwise#TimestreamTableName", + "traits": { + "smithy.api#documentation": "The name of the registered Amazon Timestream database table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer\n your vehicle data to.
" + } + }, + "com.amazonaws.iotfleetwise#TimestreamTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.iotfleetwise#TriggerMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALWAYS", + "name": "ALWAYS" + }, + { + "value": "RISING_EDGE", + "name": "RISING_EDGE" + } + ] + } + }, + "com.amazonaws.iotfleetwise#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the given tags (metadata) from the resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.iotfleetwise#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iotfleetwise#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of the keys of the tags to be removed from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleetwise#UpdateCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#UpdateCampaignRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#UpdateCampaignResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a campaign.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/campaigns/{name}", + "code": 200 + } + } + }, + "com.amazonaws.iotfleetwise#UpdateCampaignAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APPROVE", + "name": "APPROVE" + }, + { + "value": "SUSPEND", + "name": "SUSPEND" + }, + { + "value": "RESUME", + "name": "RESUME" + }, + { + "value": "UPDATE", + "name": "UPDATE" + } + ] + } + }, + "com.amazonaws.iotfleetwise#UpdateCampaignRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the campaign to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "The description of the campaign.
" + } + }, + "dataExtraDimensions": { + "target": "com.amazonaws.iotfleetwise#DataExtraDimensionNodePathList", + "traits": { + "smithy.api#documentation": "A list of vehicle attributes to associate with a signal.
\nDefault: An empty array
" + } + }, + "action": { + "target": "com.amazonaws.iotfleetwise#UpdateCampaignAction", + "traits": { + "smithy.api#documentation": "Specifies how to update a campaign. The action can be one of the following:
\n\n APPROVE - To approve delivering a data collection scheme to\n vehicles.
\n SUSPEND - To suspend collecting signal data.
\n RESUME - To resume collecting signal data.
\n UPDATE - To update a campaign.
The Amazon Resource Name (ARN) of the campaign.
" + } + }, + "name": { + "target": "com.amazonaws.iotfleetwise#campaignName", + "traits": { + "smithy.api#documentation": "The name of the updated campaign.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#CampaignStatus", + "traits": { + "smithy.api#documentation": "The state of a campaign. The status can be one of:
\n\n CREATING - Amazon Web Services IoT FleetWise is processing your request to create the\n campaign.
\n WAITING_FOR_APPROVAL - After a campaign is created, it enters the\n WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the\n campaign to the target vehicle or fleet, use the API operation to approve the campaign.\n
\n RUNNING - The campaign is active.
\n SUSPENDED - The campaign is suspended. To resume the campaign, use\n the API operation.
Updates a decoder manifest.
\nA decoder manifest can only be updated when the status is DRAFT. Only\n ACTIVE decoder manifests can be associated with vehicles.
The name of the decoder manifest to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the decoder manifest to update.
" + } + }, + "signalDecodersToAdd": { + "target": "com.amazonaws.iotfleetwise#SignalDecoders", + "traits": { + "smithy.api#documentation": "A list of information about decoding additional signals to add to the decoder\n manifest.
" + } + }, + "signalDecodersToUpdate": { + "target": "com.amazonaws.iotfleetwise#SignalDecoders", + "traits": { + "smithy.api#documentation": "A list of updated information about decoding signals to update in the decoder\n manifest.
" + } + }, + "signalDecodersToRemove": { + "target": "com.amazonaws.iotfleetwise#Fqns", + "traits": { + "smithy.api#documentation": "A list of signal decoders to remove from the decoder manifest.
" + } + }, + "networkInterfacesToAdd": { + "target": "com.amazonaws.iotfleetwise#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "A list of information about the network interfaces to add to the decoder manifest.\n
" + } + }, + "networkInterfacesToUpdate": { + "target": "com.amazonaws.iotfleetwise#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "A list of information about the network interfaces to update in the decoder manifest.\n
" + } + }, + "networkInterfacesToRemove": { + "target": "com.amazonaws.iotfleetwise#InterfaceIds", + "traits": { + "smithy.api#documentation": "A list of network interfaces to remove from the decoder manifest.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#ManifestStatus", + "traits": { + "smithy.api#documentation": " The state of the decoder manifest. If the status is ACTIVE, the decoder\n manifest can't be edited. If the status is DRAFT, you can edit the decoder\n manifest.
The name of the updated decoder manifest.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated decoder manifest.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#UpdateFleetRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#UpdateFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the description of an existing fleet.
\nIf the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response\n with an empty HTTP body.
\nThe ID of the fleet to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "An updated description of the fleet.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateFleetResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotfleetwise#fleetId", + "traits": { + "smithy.api#documentation": "The ID of the updated fleet.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated fleet.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Overwrite", + "name": "OVERWRITE" + }, + { + "value": "Merge", + "name": "MERGE" + } + ] + } + }, + "com.amazonaws.iotfleetwise#UpdateModelManifest": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#UpdateModelManifestRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#UpdateModelManifestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidSignalsException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a vehicle model (model manifest). If created vehicles are associated with a\n vehicle model, it can't be updated.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/model-manifests/{name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#UpdateModelManifestRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the vehicle model to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the vehicle model.
" + } + }, + "nodesToAdd": { + "target": "com.amazonaws.iotfleetwise#NodePaths", + "traits": { + "smithy.api#documentation": " A list of fullyQualifiedName of nodes, which are a general abstraction\n of signals, to add to the vehicle model.
A list of fullyQualifiedName of nodes, which are a general abstraction\n of signals, to remove from the vehicle model.
The state of the vehicle model. If the status is ACTIVE, the vehicle\n model can't be edited. If the status is DRAFT, you can edit the vehicle\n model.
The name of the updated vehicle model.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated vehicle model.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateSignalCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#UpdateSignalCatalogRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#UpdateSignalCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidNodeException" + }, + { + "target": "com.amazonaws.iotfleetwise#InvalidSignalsException" + }, + { + "target": "com.amazonaws.iotfleetwise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a signal catalog.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/signal-catalogs/{name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iotfleetwise#UpdateSignalCatalogRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotfleetwise#resourceName", + "traits": { + "smithy.api#documentation": "The name of the signal catalog to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotfleetwise#description", + "traits": { + "smithy.api#documentation": "A brief description of the signal catalog to update.
" + } + }, + "nodesToAdd": { + "target": "com.amazonaws.iotfleetwise#Nodes", + "traits": { + "smithy.api#documentation": "A list of information about nodes to add to the signal catalog.
" + } + }, + "nodesToUpdate": { + "target": "com.amazonaws.iotfleetwise#Nodes", + "traits": { + "smithy.api#documentation": "A list of information about nodes to update in the signal catalog.
" + } + }, + "nodesToRemove": { + "target": "com.amazonaws.iotfleetwise#NodePaths", + "traits": { + "smithy.api#documentation": " A list of fullyQualifiedName of nodes to remove from the signal catalog.\n
The name of the updated signal catalog.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the updated signal catalog.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateVehicle": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#UpdateVehicleRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#UpdateVehicleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a vehicle.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/vehicles/{vehicleName}", + "code": 204 + } + } + }, + "com.amazonaws.iotfleetwise#UpdateVehicleError": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the vehicle with the error.
" + } + }, + "code": { + "target": "com.amazonaws.iotfleetwise#number", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The relevant HTTP error code (400+).
" + } + }, + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "A message associated with the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP error resulting from updating the description for a vehicle.
" + } + }, + "com.amazonaws.iotfleetwise#UpdateVehicleRequest": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle model (model manifest) associated with the vehicle.
" + } + }, + "decoderManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the decoder manifest associated with this vehicle.
" + } + }, + "attributes": { + "target": "com.amazonaws.iotfleetwise#attributesMap", + "traits": { + "smithy.api#documentation": "Static information about a vehicle in a key-value pair. For example:
\n\n \"engineType\" : \"1.3 L R2\"\n
The method the specified attributes will update the existing attributes on the\n vehicle. UseOverwite to replace the vehicle attributes with the specified\n attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateVehicleRequestItem": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle to update.
", + "smithy.api#required": {} + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the vehicle model (model manifest) associated with the vehicle to update.
" + } + }, + "decoderManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the signal decoder manifest associated with the vehicle to update.
" + } + }, + "attributes": { + "target": "com.amazonaws.iotfleetwise#attributesMap", + "traits": { + "smithy.api#documentation": "Static information about a vehicle in a key-value pair. For example:
\n\n \"engineType\" : \"1.3 L R2\"\n
The method the specified attributes will update the existing attributes on the\n vehicle. UseOverwite to replace the vehicle attributes with the specified\n attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the vehicle to update.
" + } + }, + "com.amazonaws.iotfleetwise#UpdateVehicleResponse": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The ID of the updated vehicle.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of the updated vehicle.
" + } + } + } + }, + "com.amazonaws.iotfleetwise#UpdateVehicleResponseItem": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the updated vehicle.
" + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated vehicle.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the updated vehicle.
" + } + }, + "com.amazonaws.iotfleetwise#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.iotfleetwise#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.
" + } + }, + "fieldList": { + "target": "com.amazonaws.iotfleetwise#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleetwise#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the parameter field with the validation error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message about the validation error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A validation error due to mismatch between the expected data type, length, or pattern\n of the parameter and the input.
" + } + }, + "com.amazonaws.iotfleetwise#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#ValidationExceptionField" + } + }, + "com.amazonaws.iotfleetwise#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.iotfleetwise#VehicleAssociationBehavior": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CreateIotThing", + "name": "CREATE_IOT_THING" + }, + { + "value": "ValidateIotThingExists", + "name": "VALIDATE_IOT_THING_EXISTS" + } + ] + } + }, + "com.amazonaws.iotfleetwise#VehicleAssociationResource": { + "type": "resource", + "identifiers": { + "fleetId": { + "target": "com.amazonaws.iotfleetwise#fleetId" + }, + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName" + } + }, + "list": { + "target": "com.amazonaws.iotfleetwise#ListVehiclesInFleet" + } + }, + "com.amazonaws.iotfleetwise#VehicleResource": { + "type": "resource", + "identifiers": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName" + } + }, + "put": { + "target": "com.amazonaws.iotfleetwise#CreateVehicle" + }, + "read": { + "target": "com.amazonaws.iotfleetwise#GetVehicle" + }, + "update": { + "target": "com.amazonaws.iotfleetwise#UpdateVehicle" + }, + "delete": { + "target": "com.amazonaws.iotfleetwise#DeleteVehicle" + }, + "list": { + "target": "com.amazonaws.iotfleetwise#ListVehicles" + }, + "operations": [ + { + "target": "com.amazonaws.iotfleetwise#AssociateVehicleFleet" + }, + { + "target": "com.amazonaws.iotfleetwise#DisassociateVehicleFleet" + } + ], + "resources": [ + { + "target": "com.amazonaws.iotfleetwise#FleetAssociationResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Vehicle" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.iotfleetwise#VehicleState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "READY", + "name": "READY" + }, + { + "value": "HEALTHY", + "name": "HEALTHY" + }, + { + "value": "SUSPENDED", + "name": "SUSPENDED" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.iotfleetwise#VehicleStatus": { + "type": "structure", + "members": { + "campaignName": { + "target": "com.amazonaws.iotfleetwise#string", + "traits": { + "smithy.api#documentation": "The name of a campaign.
" + } + }, + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle.
" + } + }, + "status": { + "target": "com.amazonaws.iotfleetwise#VehicleState", + "traits": { + "smithy.api#documentation": "The state of a vehicle, which can be one of the following:
\n\n CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
\n READY - The vehicle is ready to receive a campaign deployment.\n
\n HEALTHY - A campaign deployment was delivered to the vehicle.\n
\n SUSPENDED - A campaign associated with the vehicle was suspended\n and data collection was paused.
\n DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.\n
Information about the state of a vehicle and how it relates to the status of a\n campaign.
" + } + }, + "com.amazonaws.iotfleetwise#VehicleStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#VehicleStatus" + } + }, + "com.amazonaws.iotfleetwise#VehicleSummary": { + "type": "structure", + "members": { + "vehicleName": { + "target": "com.amazonaws.iotfleetwise#vehicleName", + "traits": { + "smithy.api#documentation": "The unique ID of the vehicle.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vehicle.
", + "smithy.api#required": {} + } + }, + "modelManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a vehicle model (model manifest) associated with the vehicle.
", + "smithy.api#required": {} + } + }, + "decoderManifestArn": { + "target": "com.amazonaws.iotfleetwise#arn", + "traits": { + "smithy.api#documentation": "The ARN of a decoder manifest associated with the vehicle.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
", + "smithy.api#required": {} + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a vehicle.
\nTo return this information about vehicles in your account, you can use the API operation.
" + } + }, + "com.amazonaws.iotfleetwise#arn": { + "type": "string" + }, + "com.amazonaws.iotfleetwise#attributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.iotfleetwise#attributeValue": { + "type": "string" + }, + "com.amazonaws.iotfleetwise#attributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iotfleetwise#attributeName" + }, + "value": { + "target": "com.amazonaws.iotfleetwise#attributeValue" + } + }, + "com.amazonaws.iotfleetwise#boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.iotfleetwise#campaignName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z\\d\\-_:]+$" + } + }, + "com.amazonaws.iotfleetwise#campaignSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#CampaignSummary" + } + }, + "com.amazonaws.iotfleetwise#collectionPeriodMs": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 10000, + "max": 60000 + } + } + }, + "com.amazonaws.iotfleetwise#createVehicleErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#CreateVehicleError" + } + }, + "com.amazonaws.iotfleetwise#createVehicleRequestItems": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#CreateVehicleRequestItem" + } + }, + "com.amazonaws.iotfleetwise#createVehicleResponses": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#CreateVehicleResponseItem" + } + }, + "com.amazonaws.iotfleetwise#customerAccountId": { + "type": "string" + }, + "com.amazonaws.iotfleetwise#decoderManifestSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#DecoderManifestSummary" + } + }, + "com.amazonaws.iotfleetwise#description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" + } + }, + "com.amazonaws.iotfleetwise#double": { + "type": "double" + }, + "com.amazonaws.iotfleetwise#errorMessage": { + "type": "string" + }, + "com.amazonaws.iotfleetwise#eventExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.iotfleetwise#fleetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + } + }, + "com.amazonaws.iotfleetwise#fleetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#FleetSummary" + } + }, + "com.amazonaws.iotfleetwise#fleets": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#fleetId" + } + }, + "com.amazonaws.iotfleetwise#languageVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.iotfleetwise#listOfStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#string" + } + }, + "com.amazonaws.iotfleetwise#listVehiclesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iotfleetwise#maxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iotfleetwise#maxSampleCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 4294967295 + } + } + }, + "com.amazonaws.iotfleetwise#modelManifestSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#ModelManifestSummary" + } + }, + "com.amazonaws.iotfleetwise#nextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.iotfleetwise#nonNegativeInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.iotfleetwise#number": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.iotfleetwise#positiveInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.iotfleetwise#priority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.iotfleetwise#resourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z\\d\\-_:]+$" + } + }, + "com.amazonaws.iotfleetwise#signalCatalogSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#SignalCatalogSummary" + } + }, + "com.amazonaws.iotfleetwise#status": { + "type": "string" + }, + "com.amazonaws.iotfleetwise#string": { + "type": "string" + }, + "com.amazonaws.iotfleetwise#timestamp": { + "type": "timestamp" + }, + "com.amazonaws.iotfleetwise#uint32": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.iotfleetwise#updateVehicleErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#UpdateVehicleError" + } + }, + "com.amazonaws.iotfleetwise#updateVehicleRequestItems": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#UpdateVehicleRequestItem" + } + }, + "com.amazonaws.iotfleetwise#updateVehicleResponseItems": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#UpdateVehicleResponseItem" + } + }, + "com.amazonaws.iotfleetwise#vehicleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z\\d\\-_:]+$" + } + }, + "com.amazonaws.iotfleetwise#vehicleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#VehicleSummary" + } + }, + "com.amazonaws.iotfleetwise#vehicles": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleetwise#vehicleName" + } + }, + "com.amazonaws.iotfleetwise#wildcardSignalName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[\\w|*|-]+(\\.[\\w|*|-]+)*$" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index 14125fef8dc..95a88a3ace6 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -31,21 +31,6 @@ "shapes": { "com.amazonaws.kendra#AWSKendraFrontendService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "kendra", - "arnNamespace": "kendra", - "cloudFormationName": "Kendra", - "cloudTrailEventSource": "kendra.amazonaws.com", - "endpointPrefix": "kendra" - }, - "aws.auth#sigv4": { - "name": "kendra" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Kendra is a service for indexing large document sets.
", - "smithy.api#title": "AWSKendraFrontendService" - }, "version": "2019-02-03", "operations": [ { @@ -228,7 +213,22 @@ { "target": "com.amazonaws.kendra#UpdateThesaurus" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "kendra", + "arnNamespace": "kendra", + "cloudFormationName": "Kendra", + "cloudTrailEventSource": "kendra.amazonaws.com", + "endpointPrefix": "kendra" + }, + "aws.auth#sigv4": { + "name": "kendra" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Kendra is a service for indexing large document sets.
", + "smithy.api#title": "AWSKendraFrontendService" + } }, "com.amazonaws.kendra#AccessControlConfigurationId": { "type": "string", @@ -282,7 +282,7 @@ } }, "traits": { - "smithy.api#documentation": "Access Control List files for the documents in a data source. For\n the format of the file, see Access control for S3 data\n sources.
" + "smithy.api#documentation": "Access Control List files for the documents in a data source. For the format of the\n file, see Access control\n for S3 data sources.
" } }, "com.amazonaws.kendra#AccessDeniedException": { @@ -304,13 +304,13 @@ "AllowedGroupsColumnName": { "target": "com.amazonaws.kendra#ColumnName", "traits": { - "smithy.api#documentation": "A list of groups, separated by semi-colons, that filters a query\n response based on user context. The document is only returned to\n users that are in one of the groups specified in the\n UserContext field of the Query\n API.
A list of groups, separated by semi-colons, that filters a query response based on\n user context. The document is only returned to users that are in one of the groups\n specified in the UserContext field of the Query API.
Provides information about the column that should be used for\n filtering the query response by groups.
" + "smithy.api#documentation": "Provides information about the column that should be used for filtering the query\n response by groups.
" } }, "com.amazonaws.kendra#AdditionalResultAttribute": { @@ -354,7 +354,7 @@ "TextWithHighlightsValue": { "target": "com.amazonaws.kendra#TextWithHighlights", "traits": { - "smithy.api#documentation": "The text associated with the attribute and information about the\n highlight to apply to the text.
" + "smithy.api#documentation": "The text associated with the attribute and information about the highlight to apply to\n the text.
" } } }, @@ -363,14 +363,14 @@ } }, "com.amazonaws.kendra#AdditionalResultAttributeValueType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TEXT_WITH_HIGHLIGHTS_VALUE", - "name": "TEXT_WITH_HIGHLIGHTS_VALUE" + "type": "enum", + "members": { + "TEXT_WITH_HIGHLIGHTS_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_WITH_HIGHLIGHTS_VALUE" } - ] + } } }, "com.amazonaws.kendra#AlfrescoConfiguration": { @@ -407,12 +407,14 @@ "CrawlSystemFolders": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to index shared files.
\n TRUE to index comments of blogs and other content.
Grants users or groups in your Amazon Web Services SSO identity source access \n to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a \n search application. For more information on creating a search application \n experience, see Building \n a search experience with no code.
" + "smithy.api#documentation": "Grants users or groups in your IAM Identity Center identity source access \n to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a \n search application. For more information on creating a search application \n experience, see Building \n a search experience with no code.
" } }, "com.amazonaws.kendra#AssociateEntitiesToExperienceFailedEntityList": { @@ -555,7 +561,7 @@ "EntityList": { "target": "com.amazonaws.kendra#AssociateEntityList", "traits": { - "smithy.api#documentation": "Lists users or groups in your Amazon Web Services SSO identity source.
", + "smithy.api#documentation": "Lists users or groups in your IAM Identity Center identity source.
", "smithy.api#required": {} } } @@ -567,7 +573,7 @@ "FailedEntityList": { "target": "com.amazonaws.kendra#AssociateEntitiesToExperienceFailedEntityList", "traits": { - "smithy.api#documentation": "Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly configure with your Amazon Kendra experience.
" + "smithy.api#documentation": "Lists the users or groups in your IAM Identity Center identity source that \n failed to properly configure with your Amazon Kendra experience.
" } } } @@ -613,7 +619,7 @@ } ], "traits": { - "smithy.api#documentation": "Defines the specific permissions of users or groups in your Amazon Web Services SSO\n identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building \n a search experience with no code.
" + "smithy.api#documentation": "Defines the specific permissions of users or groups in your IAM Identity Center\n identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building \n a search experience with no code.
" } }, "com.amazonaws.kendra#AssociatePersonasToEntitiesRequest": { @@ -636,7 +642,7 @@ "Personas": { "target": "com.amazonaws.kendra#EntityPersonaConfigurationList", "traits": { - "smithy.api#documentation": "The personas that define the specific permissions of users or groups in \n your Amazon Web Services SSO identity source. The available personas or access \n roles are Owner and Viewer. For more information \n on these personas, see Providing \n access to your search page.
The personas that define the specific permissions of users or groups in \n your IAM Identity Center identity source. The available personas or access \n roles are Owner and Viewer. For more information \n on these personas, see Providing \n access to your search page.
Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly configure with your Amazon Kendra experience.
" + "smithy.api#documentation": "Lists the users or groups in your IAM Identity Center identity source that \n failed to properly configure with your Amazon Kendra experience.
" } } } @@ -853,24 +859,24 @@ "Id": { "target": "com.amazonaws.kendra#DocumentId", "traits": { - "smithy.api#documentation": "The identifier of the document that couldn't be removed from the\n index.
" + "smithy.api#documentation": "The identifier of the document that couldn't be removed from the index.
" } }, "ErrorCode": { "target": "com.amazonaws.kendra#ErrorCode", "traits": { - "smithy.api#documentation": "The error code for why the document couldn't be removed from the\n index.
" + "smithy.api#documentation": "The error code for why the document couldn't be removed from the index.
" } }, "ErrorMessage": { "target": "com.amazonaws.kendra#ErrorMessage", "traits": { - "smithy.api#documentation": "An explanation for why the document couldn't be removed from the\n index.
" + "smithy.api#documentation": "An explanation for why the document couldn't be removed from the index.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about documents that could not be removed\n from an index by the BatchDeleteDocument\n API.
Provides information about documents that could not be removed from an index by the\n BatchDeleteDocument API.
The type of error that caused the document to fail to be\n indexed.
" + "smithy.api#documentation": "The type of error that caused the document to fail to be indexed.
" } }, "ErrorMessage": { "target": "com.amazonaws.kendra#ErrorMessage", "traits": { - "smithy.api#documentation": "A description of the reason why the document could not be\n indexed.
" + "smithy.api#documentation": "A description of the reason why the document could not be indexed.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about a document that could not be\n indexed.
" + "smithy.api#documentation": "Provides information about a document that could not be indexed.
" } }, "com.amazonaws.kendra#BatchPutDocumentResponseFailedDocuments": { @@ -1092,7 +1098,10 @@ "type": "blob" }, "com.amazonaws.kendra#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.kendra#BoxConfiguration": { "type": "structure", @@ -1114,24 +1123,28 @@ "UseChangeLog": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to use the Slack change log to determine which documents require\n updating in the index. Depending on the data source change log's size, it may take\n longer for Amazon Kendra to use the change log than to scan all of your\n documents.
\n TRUE to index comments.
\n TRUE to index the contents of tasks.
\n TRUE to index web links.
The amount of extra storage capacity for an index. \n A single capacity unit provides 30 GB of storage space or 100,000 documents, \n whichever is reached first. You can add up to 100 extra capacity units.
", + "smithy.api#documentation": "The amount of extra storage capacity for an index. A single capacity unit provides 30\n GB of storage space or 100,000 documents, whichever is reached first. You can add up to\n 100 extra capacity units.
", "smithy.api#required": {} } }, "QueryCapacityUnits": { "target": "com.amazonaws.kendra#QueryCapacityUnit", "traits": { - "smithy.api#documentation": "The amount of extra query capacity for an index and \n GetQuerySuggestions \n capacity.
\nA single extra capacity unit for an index provides 0.1 queries per second or approximately \n 8,000 queries per day. You can add up to 100 extra capacity units.
\n\n GetQuerySuggestions capacity is five times the \n provisioned query capacity for an index, or the base capacity of 2.5 calls per second, \n whichever is higher. For example, the base capacity for an index is 0.1 queries per \n second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. \n If you add another 0.1 queries per second to total 0.2 queries per second for an index, the \n GetQuerySuggestions capacity is 2.5 calls per second \n (higher than five times 0.2 queries per second).
The amount of extra query capacity for an index and GetQuerySuggestions\n capacity.
\nA single extra capacity unit for an index provides 0.1 queries per second or\n approximately 8,000 queries per day. You can add up to 100 extra capacity units.
\n\n GetQuerySuggestions capacity is five times the provisioned query capacity\n for an index, or the base capacity of 2.5 calls per second, whichever is higher. For\n example, the base capacity for an index is 0.1 queries per second, and\n GetQuerySuggestions capacity has a base of 2.5 calls per second. If you\n add another 0.1 queries per second to total 0.2 queries per second for an index, the\n GetQuerySuggestions capacity is 2.5 calls per second (higher than five\n times 0.2 queries per second).
Specifies additional capacity units configured for your \n Enterprise Edition index. You can add and remove capacity units \n to fit your usage requirements.
" + "smithy.api#documentation": "Specifies additional capacity units configured for your Enterprise Edition index. You\n can add and remove capacity units to fit your usage requirements.
" } }, "com.amazonaws.kendra#ChangeDetectingColumns": { @@ -1276,20 +1289,20 @@ "ResultId": { "target": "com.amazonaws.kendra#ResultId", "traits": { - "smithy.api#documentation": "The unique identifier of the search result that was\n clicked.
", + "smithy.api#documentation": "The unique identifier of the search result that was clicked.
", "smithy.api#required": {} } }, "ClickTime": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp of the date and time that the result was\n clicked.
", + "smithy.api#documentation": "The Unix timestamp of the date and time that the result was clicked.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Gathers information about when a particular result was clicked by\n a user. Your application uses the SubmitFeedback\n API to provide click information.
Gathers information about when a particular result was clicked by a user. Your\n application uses the SubmitFeedback API to provide click\n information.
An array of objects that map database column names to the\n corresponding fields in an index. You must first create the fields\n in the index using the UpdateIndex API.
An array of objects that map database column names to the corresponding fields in an\n index. You must first create the fields in the index using the UpdateIndex\n API.
One to five columns that indicate when a document in the database\n has changed.
", + "smithy.api#documentation": "One to five columns that indicate when a document in the database has changed.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides information about how Amazon Kendra should use the columns of\n a database in an index.
" + "smithy.api#documentation": "Provides information about how Amazon Kendra should use the columns of a database\n in an index.
" } }, "com.amazonaws.kendra#ColumnName": { @@ -1359,54 +1372,74 @@ } }, "com.amazonaws.kendra#ConditionOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GreaterThan", - "name": "GreaterThan" - }, - { - "value": "GreaterThanOrEquals", - "name": "GreaterThanOrEquals" - }, - { - "value": "LessThan", - "name": "LessThan" - }, - { - "value": "LessThanOrEquals", - "name": "LessThanOrEquals" - }, - { - "value": "Equals", - "name": "Equals" - }, - { - "value": "NotEquals", - "name": "NotEquals" - }, - { - "value": "Contains", - "name": "Contains" - }, - { - "value": "NotContains", - "name": "NotContains" - }, - { - "value": "Exists", - "name": "Exists" - }, - { - "value": "NotExists", - "name": "NotExists" - }, - { - "value": "BeginsWith", - "name": "BeginsWith" - } - ] + "type": "enum", + "members": { + "GreaterThan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "GreaterThanOrEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEquals" + } + }, + "LessThan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "LessThanOrEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEquals" + } + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equals" + } + }, + "NotEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEquals" + } + }, + "Contains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Contains" + } + }, + "NotContains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotContains" + } + }, + "Exists": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exists" + } + }, + "NotExists": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotExists" + } + }, + "BeginsWith": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BeginsWith" + } + } } }, "com.amazonaws.kendra#ConflictException": { @@ -1428,6 +1461,7 @@ "CrawlAttachments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to index attachments of pages and blogs in Confluence.
\n TRUE to index personal spaces. You can\n add restrictions to items in personal spaces. If personal spaces are\n indexed, queries without user context information may return\n restricted items from a personal space in their results. For more\n information, see Filtering on\n user context.
\n TRUE to index archived spaces.
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.\n The credentials should be a user/password pair. For\n more information, see Using a\n Database Data Source. For more information about \n Secrets Manager, see What Is \n Secrets Manager in the Secrets Manager\n user guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The\n credentials should be a user/password pair. For more information, see Using a\n Database Data Source. For more information about Secrets Manager, see\n What\n Is Secrets Manager in the \n Secrets Manager\n user guide.
", "smithy.api#required": {} } } @@ -2027,6 +2131,7 @@ "DirectPutContent": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to use documents you indexed directly using the\n BatchPutDocument API.
Creates a data source connector that you want to use with an Amazon Kendra index.
\nYou specify a name, data source connector type and description for\n your data source. You also specify configuration information for the \n data source connector.
\n\n CreateDataSource is a synchronous operation. The\n operation returns 200 if the data source was successfully created.\n Otherwise, an exception is raised.
Amazon S3 and custom data sources are \n the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
\nFor an example of creating an index and data source using the Python SDK, \n see Getting \n started with Python SDK. For an example of creating an index and data \n source using the Java SDK, see Getting started with Java SDK.
" + "smithy.api#documentation": "Creates a data source connector that you want to use with an Amazon Kendra\n index.
\nYou specify a name, data source connector type and description for your data source. You\n also specify configuration information for the data source connector.
\n\n CreateDataSource is a synchronous operation. The operation returns 200 if the\n data source was successfully created. Otherwise, an exception is raised.
Amazon S3 and custom data sources are the only\n supported data sources in the Amazon Web Services GovCloud (US-West) region.
\nFor an example of creating an index and data source using the Python SDK, see Getting started with Python\n SDK. For an example of creating an index and data source using the Java SDK, see\n Getting started with Java\n SDK.
" } }, "com.amazonaws.kendra#CreateDataSourceRequest": { @@ -2266,13 +2378,13 @@ "Configuration": { "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "Configuration information to connect to your data source repository.
\nYou can't specify the Configuration parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The Configuration parameter is required for all other\n data sources.
Configuration information to connect to your data source repository.
\nYou can't specify the Configuration parameter when the Type\n parameter is set to CUSTOM. If you do, you receive a\n ValidationException exception.
The Configuration parameter is required for all other data sources.
Configuration information for an Amazon Virtual Private Cloud to connect to your \n data source. For more information, see Configuring a VPC.
" + "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect to your data source.\n For more information, see Configuring a VPC.
" } }, "Description": { @@ -2284,25 +2396,25 @@ "Schedule": { "target": "com.amazonaws.kendra#ScanSchedule", "traits": { - "smithy.api#documentation": "Sets the frequency for Amazon Kendra to check the documents in your\n data source repository and update the index. If you don't set a schedule \n Amazon Kendra will not periodically update the index. You can call the\n StartDataSourceSyncJob API to update the\n index.
You can't specify the Schedule parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
Sets the frequency for Amazon Kendra to check the documents in your data source\n repository and update the index. If you don't set a schedule Amazon Kendra will not\n periodically update the index. You can call the StartDataSourceSyncJob API to\n update the index.
You can't specify the Schedule parameter when the Type parameter\n is set to CUSTOM. If you do, you receive a ValidationException\n exception.
The Amazon Resource Name (ARN) of a role with permission to access the\n data source and required resources. For more information, see \n IAM roles for\n Amazon Kendra.
\nYou can't specify the RoleArn parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The RoleArn parameter is required for all other data\n sources.
The Amazon Resource Name (ARN) of a role with permission to access the data source and\n required resources. For more information, see IAM roles for Amazon Kendra.
\nYou can't specify the RoleArn parameter when the Type parameter\n is set to CUSTOM. If you do, you receive a ValidationException\n exception.
The RoleArn parameter is required for all other data sources.
A list of key-value pairs that identify the data source connector. You can use\n the tags to identify and organize your resources and to control access to\n resources.
" + "smithy.api#documentation": "A list of key-value pairs that identify the data source connector. You can use the tags to\n identify and organize your resources and to control access to resources.
" } }, "ClientToken": { "target": "com.amazonaws.kendra#ClientTokenName", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create a data\n source connector. Multiple calls to the CreateDataSource API \n with the same client token will create only one data source connector.
A token that you provide to identify the request to create a data source connector.\n Multiple calls to the CreateDataSource API with the same client token will create\n only one data source connector.
The Amazon Resource Name (ARN) of a role with permission to access Query\n API, QuerySuggestions API, SubmitFeedback\n API, and Amazon Web Services SSO that stores your user and group information. \n For more information, see IAM roles for Amazon Kendra.
The Amazon Resource Name (ARN) of a role with permission to access Query\n API, QuerySuggestions API, SubmitFeedback\n API, and IAM Identity Center that stores your user and group information. \n For more information, see IAM roles for Amazon Kendra.
The Amazon Kendra edition to use for the index. Choose\n DEVELOPER_EDITION for indexes intended for development,\n testing, or proof of concept. Use ENTERPRISE_EDITION for your\n production databases. Once you set the edition for an index, it can't be\n changed.
The Edition parameter is optional. If you don't supply a\n value, the default is ENTERPRISE_EDITION.
For more information on quota limits for enterprise and developer editions, \n see Quotas.
" } }, @@ -2631,7 +2745,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" + "smithy.api#documentation": "Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" } } } @@ -2881,49 +2995,49 @@ "S3Configuration": { "target": "com.amazonaws.kendra#S3DataSourceConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to an Amazon S3 \n bucket as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to an Amazon S3 bucket as\n your data source.
" } }, "SharePointConfiguration": { "target": "com.amazonaws.kendra#SharePointConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Microsoft SharePoint \n as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Microsoft SharePoint as your data\n source.
" } }, "DatabaseConfiguration": { "target": "com.amazonaws.kendra#DatabaseConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to a database as \n your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to a database as your data\n source.
" } }, "SalesforceConfiguration": { "target": "com.amazonaws.kendra#SalesforceConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to \n Salesforce as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Salesforce as your data\n source.
" } }, "OneDriveConfiguration": { "target": "com.amazonaws.kendra#OneDriveConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Microsoft\n OneDrive as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Microsoft OneDrive as your data\n source.
" } }, "ServiceNowConfiguration": { "target": "com.amazonaws.kendra#ServiceNowConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to ServiceNow\n as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to ServiceNow as your data\n source.
" } }, "ConfluenceConfiguration": { "target": "com.amazonaws.kendra#ConfluenceConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Confluence \n as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Confluence as your data\n source.
" } }, "GoogleDriveConfiguration": { "target": "com.amazonaws.kendra#GoogleDriveConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Google\n Drive as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Google Drive as your data\n source.
" } }, "WebCrawlerConfiguration": { @@ -2932,19 +3046,19 @@ "WorkDocsConfiguration": { "target": "com.amazonaws.kendra#WorkDocsConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Amazon WorkDocs \n as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Amazon WorkDocs as your data\n source.
" } }, "FsxConfiguration": { "target": "com.amazonaws.kendra#FsxConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Amazon FSx as \n your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Amazon FSx as your data\n source.
" } }, "SlackConfiguration": { "target": "com.amazonaws.kendra#SlackConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Slack as your \n data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Slack as your data source.
" } }, "BoxConfiguration": { @@ -2956,31 +3070,31 @@ "QuipConfiguration": { "target": "com.amazonaws.kendra#QuipConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Quip as your \n data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Quip as your data source.
" } }, "JiraConfiguration": { "target": "com.amazonaws.kendra#JiraConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Jira as your \n data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Jira as your data source.
" } }, "GitHubConfiguration": { "target": "com.amazonaws.kendra#GitHubConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to GitHub as \n your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to GitHub as your data\n source.
" } }, "AlfrescoConfiguration": { "target": "com.amazonaws.kendra#AlfrescoConfiguration", "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Alfresco as your \n data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Alfresco as your data\n source.
" } }, "TemplateConfiguration": { "target": "com.amazonaws.kendra#TemplateConfiguration", "traits": { - "smithy.api#documentation": "Provides a template for the configuration information to connect \n to your data source.
" + "smithy.api#documentation": "Provides a template for the configuration information to connect to your data\n source.
" } } }, @@ -3096,30 +3210,38 @@ } }, "com.amazonaws.kendra#DataSourceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } } }, "com.amazonaws.kendra#DataSourceSummary": { @@ -3158,7 +3280,7 @@ "Status": { "target": "com.amazonaws.kendra#DataSourceStatus", "traits": { - "smithy.api#documentation": "The status of the data source. When the status is\n ACTIVE the data source is ready to use.
The status of the data source. When the status is ACTIVE the data source\n is ready to use.
Summary information for an Amazon Kendra data source. Returned in a call\n to the DescribeDataSource API.
Summary information for an Amazon Kendra data source. Returned in a call to the\n DescribeDataSource API.
The UNIX datetime that the synchronization job \n completed.
" + "smithy.api#documentation": "The UNIX datetime that the synchronization job completed.
" } }, "Status": { "target": "com.amazonaws.kendra#DataSourceSyncJobStatus", "traits": { - "smithy.api#documentation": "The execution status of the synchronization job. When the\n Status field is set to SUCCEEDED, the\n synchronization job is done. If the status code is set to\n FAILED, the ErrorCode and\n ErrorMessage fields give you the reason for the\n failure.
The execution status of the synchronization job. When the Status field is\n set to SUCCEEDED, the synchronization job is done. If the status code is\n set to FAILED, the ErrorCode and ErrorMessage\n fields give you the reason for the failure.
If the Status field is set to ERROR, the\n ErrorMessage field contains a description of the\n error that caused the synchronization to fail.
If the Status field is set to ERROR, the\n ErrorMessage field contains a description of the error that caused the\n synchronization to fail.
If the Status field is set to FAILED,\n the ErrorCode field indicates the reason the \n synchronization failed.
If the Status field is set to FAILED, the\n ErrorCode field indicates the reason the synchronization failed.
If the reason that the synchronization failed is due to an error\n with the underlying data source, this field contains a code that\n identifies the error.
" + "smithy.api#documentation": "If the reason that the synchronization failed is due to an error with the underlying\n data source, this field contains a code that identifies the error.
" } }, "Metrics": { "target": "com.amazonaws.kendra#DataSourceSyncJobMetrics", "traits": { - "smithy.api#documentation": "Maps a batch delete document request to a specific data source\n sync job. This is optional and should only be supplied when\n documents are deleted by a data source connector.
" + "smithy.api#documentation": "Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a data source\n connector.
" } } }, @@ -3263,12 +3385,12 @@ "DataSourceSyncJobId": { "target": "com.amazonaws.kendra#DataSourceSyncJobId", "traits": { - "smithy.api#documentation": "The ID of the sync job that is running on the data source.
\nIf the ID of a sync job is not provided and there is a sync job \n running, then the ID of this sync job is used and metrics are \n generated for this sync job.
\nIf the ID of a sync job is not provided and there is no sync job \n running, then no metrics are generated and documents are \n indexed/deleted at the index level without sync job metrics included.
" + "smithy.api#documentation": "The ID of the sync job that is running on the data source.
\nIf the ID of a sync job is not provided and there is a sync job running, then the ID\n of this sync job is used and metrics are generated for this sync job.
\nIf the ID of a sync job is not provided and there is no sync job running, then no\n metrics are generated and documents are indexed/deleted at the index level without sync\n job metrics included.
" } } }, "traits": { - "smithy.api#documentation": "Maps a particular data source sync job to a particular data\n source.
" + "smithy.api#documentation": "Maps a particular data source sync job to a particular data source.
" } }, "com.amazonaws.kendra#DataSourceSyncJobMetrics": { @@ -3277,71 +3399,83 @@ "DocumentsAdded": { "target": "com.amazonaws.kendra#MetricValue", "traits": { - "smithy.api#documentation": "The number of documents added from the data source up to now in\n the data source sync.
" + "smithy.api#documentation": "The number of documents added from the data source up to now in the data source\n sync.
" } }, "DocumentsModified": { "target": "com.amazonaws.kendra#MetricValue", "traits": { - "smithy.api#documentation": "The number of documents modified in the data source up to now in\n the data source sync run.
" + "smithy.api#documentation": "The number of documents modified in the data source up to now in the data source sync\n run.
" } }, "DocumentsDeleted": { "target": "com.amazonaws.kendra#MetricValue", "traits": { - "smithy.api#documentation": "The number of documents deleted from the data source up to now in\n the data source sync run.
" + "smithy.api#documentation": "The number of documents deleted from the data source up to now in the data source sync\n run.
" } }, "DocumentsFailed": { "target": "com.amazonaws.kendra#MetricValue", "traits": { - "smithy.api#documentation": "The number of documents that failed to sync from the data source\n up to now in the data source sync run.
" + "smithy.api#documentation": "The number of documents that failed to sync from the data source up to now in the data\n source sync run.
" } }, "DocumentsScanned": { "target": "com.amazonaws.kendra#MetricValue", "traits": { - "smithy.api#documentation": "The current number of documents crawled by the current sync job in\n the data source.
" + "smithy.api#documentation": "The current number of documents crawled by the current sync job in the data\n source.
" } } }, "traits": { - "smithy.api#documentation": "Maps a batch delete document request to a specific data source\n sync job. This is optional and should only be supplied when\n documents are deleted by a data source connector.
" + "smithy.api#documentation": "Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a data source\n connector.
" } }, "com.amazonaws.kendra#DataSourceSyncJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "SYNCING", - "name": "SYNCING" - }, - { - "value": "INCOMPLETE", - "name": "INCOMPLETE" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "ABORTED", - "name": "ABORTED" - }, - { - "value": "SYNCING_INDEXING", - "name": "SYNCING_INDEXING" - } - ] + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING" + } + }, + "INCOMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPLETE" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + }, + "SYNCING_INDEXING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING_INDEXING" + } + } } }, "com.amazonaws.kendra#DataSourceToIndexFieldMapping": { @@ -3369,7 +3503,7 @@ } }, "traits": { - "smithy.api#documentation": "Maps a column or attribute in the data source to an index field.\n You must first create the fields in the index using the\n UpdateIndex API.
Maps a column or attribute in the data source to an index field. You must first create\n the fields in the index using the UpdateIndex API.
A list of identifiers for subnets within your Amazon VPC. The\n subnets should be able to connect to each other in the VPC, and they\n should have outgoing access to the Internet through a NAT\n device.
", + "smithy.api#documentation": "A list of identifiers for subnets within your Amazon VPC. The subnets should be able\n to connect to each other in the VPC, and they should have outgoing access to the\n Internet through a NAT device.
", "smithy.api#required": {} } }, "SecurityGroupIds": { "target": "com.amazonaws.kendra#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of identifiers of security groups within your Amazon VPC.\n The security groups should enable Amazon Kendra to connect to the data\n source.
", + "smithy.api#documentation": "A list of identifiers of security groups within your Amazon VPC. The security groups\n should enable Amazon Kendra to connect to the data source.
", "smithy.api#required": {} } } @@ -3512,14 +3682,14 @@ "ColumnConfiguration": { "target": "com.amazonaws.kendra#ColumnConfiguration", "traits": { - "smithy.api#documentation": "Information about where the index should get the document\n information from the database.
", + "smithy.api#documentation": "Information about where the index should get the document information from the\n database.
", "smithy.api#required": {} } }, "AclConfiguration": { "target": "com.amazonaws.kendra#AclConfiguration", "traits": { - "smithy.api#documentation": "Information about the database column that provides information\n for user context filtering.
" + "smithy.api#documentation": "Information about the database column that provides information for user context\n filtering.
" } }, "SqlConfiguration": { @@ -3530,30 +3700,36 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to a \n index.
" + "smithy.api#documentation": "Provides the configuration information to connect to a index.
" } }, "com.amazonaws.kendra#DatabaseEngineType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RDS_AURORA_MYSQL", - "name": "RDS_AURORA_MYSQL" - }, - { - "value": "RDS_AURORA_POSTGRESQL", - "name": "RDS_AURORA_POSTGRESQL" - }, - { - "value": "RDS_MYSQL", - "name": "RDS_MYSQL" - }, - { - "value": "RDS_POSTGRESQL", - "name": "RDS_POSTGRESQL" - } - ] + "type": "enum", + "members": { + "RDS_AURORA_MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_AURORA_MYSQL" + } + }, + "RDS_AURORA_POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_AURORA_POSTGRESQL" + } + }, + "RDS_MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_MYSQL" + } + }, + "RDS_POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_POSTGRESQL" + } + } } }, "com.amazonaws.kendra#DatabaseHost": { @@ -3578,7 +3754,6 @@ "com.amazonaws.kendra#DatabasePort": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 65535 @@ -3669,7 +3844,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Amazon Kendra data source connector. An exception is not thrown if the\n data source is already being deleted. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to\n DELETING. For more information, see Deleting Data Sources.
Deletes an Amazon Kendra data source connector. An exception is not thrown if the\n data source is already being deleted. While the data source is being deleted, the\n Status field returned by a call to the DescribeDataSource API is\n set to DELETING. For more information, see Deleting Data Sources.
Configuration details for the data source connector. This shows how the \n data source is configured. The configuration options for a data \n source depend on the data source provider.
" + "smithy.api#documentation": "Configuration details for the data source connector. This shows how the data source is\n configured. The configuration options for a data source depend on the data source\n provider.
" } }, "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect to your \n data source. For more information, see Configuring a VPC.
" + "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect to your data source.\n For more information, see Configuring a VPC.
" } }, "CreatedAt": { @@ -4198,7 +4373,7 @@ "Status": { "target": "com.amazonaws.kendra#DataSourceStatus", "traits": { - "smithy.api#documentation": "The current status of the data source connector. When the status is\n ACTIVE the data source is ready to use. When the status is\n FAILED, the ErrorMessage field contains the\n reason that the data source failed.
The current status of the data source connector. When the status is ACTIVE\n the data source is ready to use. When the status is FAILED, the\n ErrorMessage field contains the reason that the data source failed.
The Amazon Resource Name (ARN) of the role with permission to access \n the data source and required resources.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role with permission to access the data source and\n required resources.
" } }, "ErrorMessage": { "target": "com.amazonaws.kendra#ErrorMessage", "traits": { - "smithy.api#documentation": "When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that\n caused the data source to fail.
When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that caused the data\n source to fail.
Shows the Amazon Resource Name (ARN) of a role with permission to access \n Query API, QuerySuggestions API, \n SubmitFeedback API, and Amazon Web Services SSO that stores \n your user and group information.
Shows the Amazon Resource Name (ARN) of a role with permission to access \n Query API, QuerySuggestions API, \n SubmitFeedback API, and IAM Identity Center that stores \n your user and group information.
Whether you have enabled the configuration for fetching access \n levels of groups and users from an Amazon Web Services Single Sign On identity source.
" + "smithy.api#documentation": "Whether you have enabled the configuration for fetching access \n levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.
" } } } @@ -5088,7 +5263,7 @@ } ], "traits": { - "smithy.api#documentation": "Prevents users or groups in your Amazon Web Services SSO identity source\n from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search \n application experience, see Building \n a search experience with no code.
" + "smithy.api#documentation": "Prevents users or groups in your IAM Identity Center identity source\n from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search \n application experience, see Building \n a search experience with no code.
" } }, "com.amazonaws.kendra#DisassociateEntitiesFromExperienceRequest": { @@ -5111,7 +5286,7 @@ "EntityList": { "target": "com.amazonaws.kendra#DisassociateEntityList", "traits": { - "smithy.api#documentation": "Lists users or groups in your Amazon Web Services SSO identity source.
", + "smithy.api#documentation": "Lists users or groups in your IAM Identity Center identity source.
", "smithy.api#required": {} } } @@ -5123,7 +5298,7 @@ "FailedEntityList": { "target": "com.amazonaws.kendra#FailedEntityList", "traits": { - "smithy.api#documentation": "Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly remove access to your Amazon Kendra experience.
" + "smithy.api#documentation": "Lists the users or groups in your IAM Identity Center identity source that \n failed to properly remove access to your Amazon Kendra experience.
" } } } @@ -5166,7 +5341,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specific permissions of users or groups in your Amazon Web Services SSO \n identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building a \n search experience with no code.
" + "smithy.api#documentation": "Removes the specific permissions of users or groups in your IAM Identity Center \n identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building a \n search experience with no code.
" } }, "com.amazonaws.kendra#DisassociatePersonasFromEntitiesRequest": { @@ -5189,7 +5364,7 @@ "EntityIds": { "target": "com.amazonaws.kendra#EntityIdsList", "traits": { - "smithy.api#documentation": "The identifiers of users or groups in your Amazon Web Services SSO identity \n source. For example, user IDs could be user emails.
", + "smithy.api#documentation": "The identifiers of users or groups in your IAM Identity Center identity \n source. For example, user IDs could be user emails.
", "smithy.api#required": {} } } @@ -5201,7 +5376,7 @@ "FailedEntityList": { "target": "com.amazonaws.kendra#FailedEntityList", "traits": { - "smithy.api#documentation": "Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly remove access to your Amazon Kendra experience.
" + "smithy.api#documentation": "Lists the users or groups in your IAM Identity Center identity source that \n failed to properly remove access to your Amazon Kendra experience.
" } } } @@ -5212,7 +5387,7 @@ "Id": { "target": "com.amazonaws.kendra#DocumentId", "traits": { - "smithy.api#documentation": "A unique identifier of the document in the index.
\nNote, each document ID must be unique per index. You cannot create a data source \n to index your documents with their unique IDs and then use the \n BatchPutDocument API to index the same documents, or vice versa. You \n can delete a data source and then use the BatchPutDocument API to index \n the same documents, or vice versa.
A unique identifier of the document in the index.
\nNote, each document ID must be unique per index. You cannot create a data source to\n index your documents with their unique IDs and then use the\n BatchPutDocument API to index the same documents, or vice versa. You\n can delete a data source and then use the BatchPutDocument API to index the\n same documents, or vice versa.
The contents of the document.
\nDocuments passed to the Blob parameter must be base64\n encoded. Your code might not need to encode the document file bytes\n if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are\n calling the Amazon Kendra endpoint directly using REST, you must base64\n encode the contents before sending.
The contents of the document.
\nDocuments passed to the Blob parameter must be base64 encoded. Your code\n might not need to encode the document file bytes if you're using an Amazon Web Services\n SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint\n directly using REST, you must base64 encode the contents before sending.
Custom attributes to apply to the document. Use the custom\n attributes to provide additional information for searching, to\n provide facets for refining searches, and to provide additional\n information in the query response.
\nFor example, 'DataSourceId' and 'DataSourceSyncJobId' are custom \n attributes that provide information on the synchronization \n of documents running on a data source. Note, \n 'DataSourceSyncJobId' could be an optional custom attribute \n as Amazon Kendra will use the ID of a running sync job.
" + "smithy.api#documentation": "Custom attributes to apply to the document. Use the custom attributes to provide\n additional information for searching, to provide facets for refining searches, and to\n provide additional information in the query response.
\nFor example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that\n provide information on the synchronization of documents running on a data source. Note,\n 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of\n a running sync job.
" } }, "AccessControlList": { "target": "com.amazonaws.kendra#PrincipalList", "traits": { - "smithy.api#documentation": "Information on principals (users and/or groups) and which documents \n they should have access to. This is useful for user context filtering, \n where search results are filtered based on the user or their group \n access to documents.
" + "smithy.api#documentation": "Information on principals (users and/or groups) and which documents they should have\n access to. This is useful for user context filtering, where search results are filtered\n based on the user or their group access to documents.
" } }, "HierarchicalAccessControlList": { "target": "com.amazonaws.kendra#HierarchicalPrincipalList", "traits": { - "smithy.api#documentation": "The list of principal lists \n that define the hierarchy for which documents users should have access to.
" + "smithy.api#documentation": "The list of principal lists that define the hierarchy for which documents users should\n have access to.
" } }, "ContentType": { "target": "com.amazonaws.kendra#ContentType", "traits": { - "smithy.api#documentation": "The file type of the document in the Blob\n field.
The file type of the document in the Blob field.
The identifier of the access control configuration that you want \n to apply to the document.
" + "smithy.api#documentation": "The identifier of the access control configuration that you want to apply to the\n document.
" } } }, @@ -5285,7 +5460,7 @@ } }, "traits": { - "smithy.api#documentation": "A document attribute or metadata field. To create custom document \n attributes, see Custom attributes.
" + "smithy.api#documentation": "A document attribute or metadata field. To create custom document attributes, see\n Custom\n attributes.
" } }, "com.amazonaws.kendra#DocumentAttributeCondition": { @@ -5371,6 +5546,7 @@ "TargetDocumentAttributeValueDeletion": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to delete the existing target value for your specified target \n attribute key. You cannot create a target value and set this to TRUE. \n To create a target value (TargetDocumentAttributeValue), set this to \n FALSE.
A date expressed as an ISO 8601 string.
\nIt is important for the time zone to be included \n in the ISO 8601 date-time format. For example, \n 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format \n for March 25th 2012 at 12:30PM (plus 10 seconds) in \n Central European Time.
" + "smithy.api#documentation": "A date expressed as an ISO 8601 string.
\nIt is important for the time zone to be included in the ISO 8601 date-time format. For\n example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012\n at 12:30PM (plus 10 seconds) in Central European Time.
" } } }, "traits": { - "smithy.api#documentation": "The value of a document attribute. You can only provide one\n value for a document attribute.
" + "smithy.api#documentation": "The value of a document attribute. You can only provide one value for a document\n attribute.
" } }, "com.amazonaws.kendra#DocumentAttributeValueCountPair": { @@ -5429,18 +5605,18 @@ "Count": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "The number of documents in the response that have the attribute\n value for the key.
" + "smithy.api#documentation": "The number of documents in the response that have the attribute value for the\n key.
" } }, "FacetResults": { "target": "com.amazonaws.kendra#FacetResultList", "traits": { - "smithy.api#documentation": "Contains the results of a document attribute that is a nested facet. \n A FacetResult contains the counts for each facet nested \n within a facet.
For example, the document attribute or facet \"Department\" includes a \n value called \"Engineering\". In addition, the document attribute \n or facet \"SubDepartment\" includes the values \"Frontend\" and \"Backend\" \n for documents assigned to \"Engineering\". You can display nested facets \n in the search results so that documents can be searched not only by \n department but also by a sub department within a department. The counts \n for documents that belong to \"Frontend\" and \"Backend\" within \"Engineering\" \n are returned for a query.
" + "smithy.api#documentation": "Contains the results of a document attribute that is a nested facet. A\n FacetResult contains the counts for each facet nested within a\n facet.
For example, the document attribute or facet \"Department\" includes a value called\n \"Engineering\". In addition, the document attribute or facet \"SubDepartment\" includes the\n values \"Frontend\" and \"Backend\" for documents assigned to \"Engineering\". You can display\n nested facets in the search results so that documents can be searched not only by\n department but also by a sub department within a department. The counts for documents\n that belong to \"Frontend\" and \"Backend\" within \"Engineering\" are returned for a\n query.
" } } }, "traits": { - "smithy.api#documentation": "Provides the count of documents that match a particular attribute\n when doing a faceted search.
" + "smithy.api#documentation": "Provides the count of documents that match a particular attribute when doing a faceted\n search.
" } }, "com.amazonaws.kendra#DocumentAttributeValueCountPairList": { @@ -5450,26 +5626,32 @@ } }, "com.amazonaws.kendra#DocumentAttributeValueType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STRING_VALUE", - "name": "STRING_VALUE" - }, - { - "value": "STRING_LIST_VALUE", - "name": "STRING_LIST_VALUE" - }, - { - "value": "LONG_VALUE", - "name": "LONG_VALUE" - }, - { - "value": "DATE_VALUE", - "name": "DATE_VALUE" - } - ] + "type": "enum", + "members": { + "STRING_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING_VALUE" + } + }, + "STRING_LIST_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING_LIST_VALUE" + } + }, + "LONG_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG_VALUE" + } + }, + "DATE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_VALUE" + } + } } }, "com.amazonaws.kendra#DocumentId": { @@ -5539,10 +5721,7 @@ } }, "com.amazonaws.kendra#DocumentMetadataBoolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.kendra#DocumentMetadataConfiguration": { "type": "structure", @@ -5564,18 +5743,18 @@ "Relevance": { "target": "com.amazonaws.kendra#Relevance", "traits": { - "smithy.api#documentation": "Provides tuning parameters to determine how the field\n affects the search results.
" + "smithy.api#documentation": "Provides tuning parameters to determine how the field affects the search\n results.
" } }, "Search": { "target": "com.amazonaws.kendra#Search", "traits": { - "smithy.api#documentation": "Provides information about how the field is used during a\n search.
" + "smithy.api#documentation": "Provides information about how the field is used during a search.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the properties, such as relevance tuning \n and searchability, of an index field.
" + "smithy.api#documentation": "Specifies the properties, such as relevance tuning and searchability, of an index\n field.
" } }, "com.amazonaws.kendra#DocumentMetadataConfigurationList": { @@ -5634,34 +5813,44 @@ } }, "com.amazonaws.kendra#DocumentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_FOUND", - "name": "NOT_FOUND" - }, - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "INDEXED", - "name": "INDEXED" - }, - { - "value": "UPDATED", - "name": "UPDATED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - } - ] + "type": "enum", + "members": { + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "INDEXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEXED" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } } }, "com.amazonaws.kendra#DocumentStatusList": { @@ -5676,12 +5865,12 @@ "S3Prefix": { "target": "com.amazonaws.kendra#S3ObjectKey", "traits": { - "smithy.api#documentation": "A prefix used to filter metadata configuration files in the Amazon Web Services S3\n bucket. The S3 bucket might contain multiple metadata files. Use\n S3Prefix to include only the desired metadata\n files.
A prefix used to filter metadata configuration files in the Amazon Web Services S3\n bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix\n to include only the desired metadata files.
Document metadata files that contain information such as the\n document access control information, source URI, document author,\n and custom attributes. Each metadata file contains metadata about a\n single document.
" + "smithy.api#documentation": "Document metadata files that contain information such as the document access control\n information, source URI, document author, and custom attributes. Each metadata file\n contains metadata about a single document.
" } }, "com.amazonaws.kendra#Domain": { @@ -5715,14 +5904,14 @@ } }, "com.amazonaws.kendra#EndpointType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HOME", - "name": "HOME" + "type": "enum", + "members": { + "HOME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOME" } - ] + } } }, "com.amazonaws.kendra#EnterpriseId": { @@ -5741,7 +5930,7 @@ "EntityId": { "target": "com.amazonaws.kendra#EntityId", "traits": { - "smithy.api#documentation": "The identifier of a user or group in your Amazon Web Services SSO identity \n source. For example, a user ID could be an email.
", + "smithy.api#documentation": "The identifier of a user or group in your IAM Identity Center identity \n source. For example, a user ID could be an email.
", "smithy.api#required": {} } }, @@ -5754,7 +5943,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for users or groups in \n your Amazon Web Services SSO identity source to grant access your Amazon Kendra \n experience.
" + "smithy.api#documentation": "Provides the configuration information for users or groups in \n your IAM Identity Center identity source to grant access your Amazon Kendra \n experience.
" } }, "com.amazonaws.kendra#EntityDisplayData": { @@ -5835,20 +6024,20 @@ "EntityId": { "target": "com.amazonaws.kendra#EntityId", "traits": { - "smithy.api#documentation": "The identifier of a user or group in your Amazon Web Services SSO identity \n source. For example, a user ID could be an email.
", + "smithy.api#documentation": "The identifier of a user or group in your IAM Identity Center identity \n source. For example, a user ID could be an email.
", "smithy.api#required": {} } }, "Persona": { "target": "com.amazonaws.kendra#Persona", "traits": { - "smithy.api#documentation": "The persona that defines the specific permissions of the user or group \n in your Amazon Web Services SSO identity source. The available personas or \n access roles are Owner and Viewer. For more \n information on these personas, see Providing \n access to your search page.
The persona that defines the specific permissions of the user or group \n in your IAM Identity Center identity source. The available personas or \n access roles are Owner and Viewer. For more \n information on these personas, see Providing \n access to your search page.
Provides the configuration information for users or groups in your \n Amazon Web Services SSO identity source for access to your Amazon Kendra experience. \n Specific permissions are defined for each user or group once they are \n granted access to your Amazon Kendra experience.
" + "smithy.api#documentation": "Provides the configuration information for users or groups in your \n IAM Identity Center identity source for access to your Amazon Kendra experience. \n Specific permissions are defined for each user or group once they are \n granted access to your Amazon Kendra experience.
" } }, "com.amazonaws.kendra#EntityPersonaConfigurationList": { @@ -5864,33 +6053,37 @@ } }, "com.amazonaws.kendra#EntityType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USER", - "name": "USER" - }, - { - "value": "GROUP", - "name": "GROUP" + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" } - ] + } } }, "com.amazonaws.kendra#ErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InternalError", - "name": "INTERNAL_ERROR" - }, - { - "value": "InvalidRequest", - "name": "INVALID_REQUEST" + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalError" + } + }, + "INVALID_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRequest" } - ] + } } }, "com.amazonaws.kendra#ErrorMessage": { @@ -5951,7 +6144,7 @@ "UserIdentityConfiguration": { "target": "com.amazonaws.kendra#UserIdentityConfiguration", "traits": { - "smithy.api#documentation": "The Amazon Web Services SSO field name that contains the identifiers of your users, \n such as their emails.
" + "smithy.api#documentation": "The IAM Identity Center field name that contains the identifiers of your users, \n such as their emails.
" } } }, @@ -5997,7 +6190,7 @@ "EntityId": { "target": "com.amazonaws.kendra#EntityId", "traits": { - "smithy.api#documentation": "The identifier of a user or group in your Amazon Web Services SSO identity source. \n For example, a user ID could be an email.
" + "smithy.api#documentation": "The identifier of a user or group in your IAM Identity Center identity source. \n For example, a user ID could be an email.
" } }, "EntityType": { @@ -6014,7 +6207,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary information for users or groups in your Amazon Web Services SSO identity\n source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building \n a search experience with no code.
" + "smithy.api#documentation": "Summary information for users or groups in your IAM Identity Center identity\n source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building \n a search experience with no code.
" } }, "com.amazonaws.kendra#ExperienceEntitiesSummaryList": { @@ -6044,26 +6237,32 @@ } }, "com.amazonaws.kendra#ExperienceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.kendra#ExperiencesSummary": { @@ -6128,6 +6327,7 @@ "MaxResults": { "target": "com.amazonaws.kendra#TopDocumentAttributeValueCountPairsSize", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Maximum number of facet values per facet. The default is 10. You can use \n this to limit the number of facet values to less than 10. If you want to \n increase the default, contact Support.
" } } @@ -6180,18 +6380,18 @@ "EntityId": { "target": "com.amazonaws.kendra#EntityId", "traits": { - "smithy.api#documentation": "The identifier of the user or group in your Amazon Web Services SSO identity \n source. For example, a user ID could be an email.
" + "smithy.api#documentation": "The identifier of the user or group in your IAM Identity Center identity \n source. For example, a user ID could be an email.
" } }, "ErrorMessage": { "target": "com.amazonaws.kendra#ErrorMessage", "traits": { - "smithy.api#documentation": "The reason the user or group in your Amazon Web Services SSO identity source \n failed to properly configure with your Amazon Kendra experience.
" + "smithy.api#documentation": "The reason the user or group in your IAM Identity Center identity source \n failed to properly configure with your Amazon Kendra experience.
" } } }, "traits": { - "smithy.api#documentation": "Information on the users or groups in your Amazon Web Services SSO identity \n source that failed to properly configure with your Amazon Kendra experience.
" + "smithy.api#documentation": "Information on the users or groups in your IAM Identity Center identity \n source that failed to properly configure with your Amazon Kendra experience.
" } }, "com.amazonaws.kendra#FailedEntityList": { @@ -6217,22 +6417,26 @@ } }, "com.amazonaws.kendra#FaqFileFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "CSV_WITH_HEADER", - "name": "CSV_WITH_HEADER" - }, - { - "value": "JSON", - "name": "JSON" + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "CSV_WITH_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV_WITH_HEADER" } - ] + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } } }, "com.amazonaws.kendra#FaqId": { @@ -6273,40 +6477,49 @@ "IndexedQuestionAnswersCount": { "target": "com.amazonaws.kendra#IndexedQuestionAnswersCount", "traits": { - "smithy.api#documentation": "The total number of FAQ questions and answers contained in the\n index.
", + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of FAQ questions and answers contained in the index.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides statistical information about the FAQ questions and\n answers contained in an index.
" + "smithy.api#documentation": "Provides statistical information about the FAQ questions and answers contained in an\n index.
" } }, "com.amazonaws.kendra#FaqStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.kendra#FaqSummary": { @@ -6321,13 +6534,13 @@ "Name": { "target": "com.amazonaws.kendra#FaqName", "traits": { - "smithy.api#documentation": "The name that you assigned the FAQ when you created or updated the\n FAQ.
" + "smithy.api#documentation": "The name that you assigned the FAQ when you created or updated the FAQ.
" } }, "Status": { "target": "com.amazonaws.kendra#FaqStatus", "traits": { - "smithy.api#documentation": "The current status of the FAQ. When the status is\n ACTIVE the FAQ is ready for use.
The current status of the FAQ. When the status is ACTIVE the FAQ is ready\n for use.
Summary information for frequently asked questions and answers \n included in an index.
" + "smithy.api#documentation": "Summary information for frequently asked questions and answers included in an\n index.
" } }, "com.amazonaws.kendra#FaqSummaryItems": { @@ -6454,14 +6667,14 @@ } }, "com.amazonaws.kendra#FsxFileSystemType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "WINDOWS" + "type": "enum", + "members": { + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" } - ] + } } }, "com.amazonaws.kendra#GetQuerySuggestions": { @@ -6670,6 +6883,7 @@ "UseChangeLog": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to use the GitHub change log to determine which documents require\n updating in the index. Depending on the GitHub change log's size, it may take longer\n for Amazon Kendra to use the change log than to scan all of your documents in\n GitHub.
\n TRUE to index all files with a repository.
\n TRUE to index all issues within a repository.
\n TRUE to index all comments on issues.
\n TRUE to include all comment attachments for issues.
\n TRUE to index all pull requests within a repository.
\n TRUE to index all comments on pull requests.
\n TRUE to include all comment attachments for pull requests.
A list of principal lists \n that define the hierarchy for which documents users should have access to. \n Each hierarchical list specifies which user or group has allow or deny \n access for each document.
", + "smithy.api#documentation": "A list of principal lists that define the hierarchy for which documents users should\n have access to. Each hierarchical list specifies which user or group has allow or deny\n access for each document.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n Information to define the hierarchy for which documents users should have access to.\n
" + "smithy.api#documentation": "Information to define the hierarchy for which documents users should have access to.\n
" } }, "com.amazonaws.kendra#HierarchicalPrincipalList": { @@ -7030,7 +7251,7 @@ "target": "com.amazonaws.kendra#HierarchicalPrincipal" }, "traits": { - "smithy.api#documentation": "A list of principal lists \n that define the hierarchy for which documents users should have access to. \n Each hierarchical list specifies which user or group has allow or deny \n access for each document.
", + "smithy.api#documentation": "A list of principal lists that define the hierarchy for which documents users should\n have access to. Each hierarchical list specifies which user or group has allow or deny\n access for each document.
", "smithy.api#length": { "min": 1, "max": 30 @@ -7043,21 +7264,22 @@ "BeginOffset": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "The zero-based location in the response string where the highlight\n starts.
", + "smithy.api#documentation": "The zero-based location in the response string where the highlight starts.
", "smithy.api#required": {} } }, "EndOffset": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "The zero-based location in the response string where the highlight\n ends.
", + "smithy.api#documentation": "The zero-based location in the response string where the highlight ends.
", "smithy.api#required": {} } }, "TopAnswer": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the response is the best response. True if this\n is the best response; otherwise, false.
" + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the response is the best response. True if this is the best\n response; otherwise, false.
" } }, "Type": { @@ -7068,7 +7290,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information that you can use to highlight a search result\n so that your users can quickly identify terms in the\n response.
" + "smithy.api#documentation": "Provides information that you can use to highlight a search result so that your users\n can quickly identify terms in the response.
" } }, "com.amazonaws.kendra#HighlightList": { @@ -7078,18 +7300,20 @@ } }, "com.amazonaws.kendra#HighlightType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDARD", - "name": "STANDARD" - }, - { - "value": "THESAURUS_SYNONYM", - "name": "THESAURUS_SYNONYM" + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "THESAURUS_SYNONYM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THESAURUS_SYNONYM" } - ] + } } }, "com.amazonaws.kendra#HookConfiguration": { @@ -7143,7 +7367,6 @@ "com.amazonaws.kendra#Importance": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 @@ -7162,13 +7385,13 @@ "Id": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "A unique identifier for the index. Use this to identify the index\n when you are using APIs such as Query,\n DescribeIndex, UpdateIndex, and\n DeleteIndex.
A unique identifier for the index. Use this to identify the index when you are using\n APIs such as Query, DescribeIndex, UpdateIndex,\n and DeleteIndex.
Indicates whether the index is a enterprise edition index or a\n developer edition index.
" + "smithy.api#documentation": "Indicates whether the index is a enterprise edition index or a developer edition\n index.
" } }, "CreatedAt": { @@ -7181,14 +7404,14 @@ "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the index was last updated by the\n UpdateIndex API.
The Unix timestamp when the index was last updated by the UpdateIndex\n API.
The current status of the index. When the status is\n ACTIVE, the index is ready to search.
The current status of the index. When the status is ACTIVE, the index is\n ready to search.
Provides information about the number of documents and the number\n of questions and answers in an index.
" + "smithy.api#documentation": "Provides information about the number of documents and the number of questions and\n answers in an index.
" } }, "com.amazonaws.kendra#IndexStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "SYSTEM_UPDATING", - "name": "SYSTEM_UPDATING" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_UPDATING" + } + } } }, "com.amazonaws.kendra#IndexedQuestionAnswersCount": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -7312,6 +7548,7 @@ "com.amazonaws.kendra#IndexedTextBytes": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -7320,6 +7557,7 @@ "com.amazonaws.kendra#IndexedTextDocumentsCount": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -7343,6 +7581,7 @@ "DocumentContentDeletion": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to delete content if the condition used for the target \n attribute is met.
\n TRUE to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira.
Gets statistics about synchronizing a data\n source connector.
", + "smithy.api#documentation": "Gets statistics about synchronizing a data source connector.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7841,25 +8094,25 @@ "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve), \n Amazon Kendra returns a pagination token in the response. You can use this pagination token \n to retrieve the next set of jobs.
" + "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of jobs.
" } }, "MaxResults": { "target": "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest", "traits": { - "smithy.api#documentation": "The maximum number of synchronization jobs to return in the response.\n If there are fewer results in the list, this response contains only the\n actual results.
" + "smithy.api#documentation": "The maximum number of synchronization jobs to return in the response. If there are fewer\n results in the list, this response contains only the actual results.
" } }, "StartTimeFilter": { "target": "com.amazonaws.kendra#TimeRange", "traits": { - "smithy.api#documentation": "When specified, the synchronization jobs returned in the list are\n limited to jobs between the specified dates.
" + "smithy.api#documentation": "When specified, the synchronization jobs returned in the list are limited to jobs between\n the specified dates.
" } }, "StatusFilter": { "target": "com.amazonaws.kendra#DataSourceSyncJobStatus", "traits": { - "smithy.api#documentation": "Only returns synchronization jobs with the\n Status field equal to the specified status.
Only returns synchronization jobs with the Status field equal to the\n specified status.
If the response is truncated, Amazon Kendra returns this token that you \n can use in the subsequent request to retrieve the next set of jobs.
" + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token that you can use in\n the subsequent request to retrieve the next set of jobs.
" } } } @@ -7928,7 +8181,7 @@ "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was incomplete (because there is more data to\n retrieve), Amazon Kendra returns a pagination token in the response. You\n can use this pagination token to retrieve the next set of data source connectors\n (DataSourceSummaryItems).
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of data source connectors (DataSourceSummaryItems).
If the response is truncated, Amazon Kendra returns this token that you\n can use in the subsequent request to retrieve the next set of data\n source connectors.
" + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token that you can use in\n the subsequent request to retrieve the next set of data source connectors.
" } } } @@ -8064,7 +8317,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists users or groups in your Amazon Web Services SSO identity source that are \n granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search \n application experience, see Building \n a search experience with no code.
", + "smithy.api#documentation": "Lists users or groups in your IAM Identity Center identity source that are \n granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search \n application experience, see Building \n a search experience with no code.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken" @@ -8628,15 +8881,11 @@ } }, "com.amazonaws.kendra#Long": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.kendra#LookBackPeriod": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 168 @@ -8646,7 +8895,6 @@ "com.amazonaws.kendra#MaxContentSizePerPageInMegaBytes": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0.000001, "max": 50 @@ -8656,7 +8904,6 @@ "com.amazonaws.kendra#MaxLinksPerPage": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 @@ -8666,7 +8913,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListAccessControlConfigurationsRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8676,7 +8922,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 @@ -8686,7 +8931,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListDataSourcesRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8696,7 +8940,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListEntityPersonasRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8706,7 +8949,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListExperiencesRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8716,7 +8958,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListFaqsRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8726,7 +8967,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListIndicesRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8736,7 +8976,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListPrincipalsRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 @@ -8746,7 +8985,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListQuerySuggestionsBlockLists": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8756,7 +8994,6 @@ "com.amazonaws.kendra#MaxResultsIntegerForListThesauriRequest": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -8766,7 +9003,6 @@ "com.amazonaws.kendra#MaxUrlsPerMinuteCrawlRate": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 300 @@ -8834,34 +9070,44 @@ } }, "com.amazonaws.kendra#MetricType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "QUERIES_BY_COUNT", - "name": "QUERIES_BY_COUNT" - }, - { - "value": "QUERIES_BY_ZERO_CLICK_RATE", - "name": "QUERIES_BY_ZERO_CLICK_RATE" - }, - { - "value": "QUERIES_BY_ZERO_RESULT_RATE", - "name": "QUERIES_BY_ZERO_RESULT_RATE" - }, - { - "value": "DOCS_BY_CLICK_COUNT", - "name": "DOCS_BY_CLICK_COUNT" - }, - { - "value": "AGG_QUERY_DOC_METRICS", - "name": "AGG_QUERY_DOC_METRICS" - }, - { - "value": "TREND_QUERY_DOC_METRICS", - "name": "TREND_QUERY_DOC_METRICS" - } - ] + "type": "enum", + "members": { + "QUERIES_BY_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERIES_BY_COUNT" + } + }, + "QUERIES_BY_ZERO_CLICK_RATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERIES_BY_ZERO_CLICK_RATE" + } + }, + "QUERIES_BY_ZERO_RESULT_RATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERIES_BY_ZERO_RESULT_RATE" + } + }, + "DOCS_BY_CLICK_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCS_BY_CLICK_COUNT" + } + }, + "AGG_QUERY_DOC_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGG_QUERY_DOC_METRICS" + } + }, + "TREND_QUERY_DOC_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TREND_QUERY_DOC_METRICS" + } + } } }, "com.amazonaws.kendra#MetricValue": { @@ -8883,7 +9129,6 @@ "com.amazonaws.kendra#MinimumNumberOfQueryingUsers": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10000 @@ -8893,7 +9138,6 @@ "com.amazonaws.kendra#MinimumQueryCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10000 @@ -8901,18 +9145,20 @@ } }, "com.amazonaws.kendra#Mode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "LEARN_ONLY", - "name": "LEARN_ONLY" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" } - ] + }, + "LEARN_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEARN_ONLY" + } + } } }, "com.amazonaws.kendra#NameType": { @@ -8936,10 +9182,7 @@ } }, "com.amazonaws.kendra#ObjectBoolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.kendra#OnPremiseConfiguration": { "type": "structure", @@ -8983,7 +9226,7 @@ "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Managersecret\n that contains the user name and password to connect to OneDrive. The\n user namd should be the application ID for the OneDrive application,\n and the password is the application key for the OneDrive\n application.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the\n user name and password to connect to OneDrive. The user namd should be the application\n ID for the OneDrive application, and the password is the application key for the\n OneDrive application.
", "smithy.api#required": {} } }, @@ -8997,30 +9240,31 @@ "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of regular expression patterns to include certain documents \n in your OneDrive. Documents that match the\n patterns are included in the index. Documents that don't match the\n patterns are excluded from the index. If a document matches both an\n inclusion and exclusion pattern, the exclusion pattern takes \n precedence and the document isn't included in the index.
\nThe pattern is applied to the file name.
" + "smithy.api#documentation": "A list of regular expression patterns to include certain documents in your OneDrive.\n Documents that match the patterns are included in the index. Documents that don't match\n the patterns are excluded from the index. If a document matches both an inclusion and\n exclusion pattern, the exclusion pattern takes precedence and the document isn't\n included in the index.
\nThe pattern is applied to the file name.
" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of regular expression patterns to exclude certain documents \n in your OneDrive. Documents that match the\n patterns are excluded from the index. Documents that don't match the\n patterns are included in the index. If a document matches both an\n inclusion and exclusion pattern, the exclusion pattern takes \n precedence and the document isn't included in the index.
\nThe pattern is applied to the file name.
" + "smithy.api#documentation": "A list of regular expression patterns to exclude certain documents in your OneDrive.\n Documents that match the patterns are excluded from the index. Documents that don't\n match the patterns are included in the index. If a document matches both an inclusion\n and exclusion pattern, the exclusion pattern takes precedence and the document isn't\n included in the index.
\nThe pattern is applied to the file name.
" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map OneDrive data \n source attributes or field names to Amazon Kendra index field names. To create \n custom fields, use the UpdateIndex API before you map to OneDrive fields. \n For more information, see Mapping data source fields. \n The OneDrive data source field names must exist in your OneDrive custom metadata.
A list of DataSourceToIndexFieldMapping objects that map OneDrive data\n source attributes or field names to Amazon Kendra index field names. To create\n custom fields, use the UpdateIndex API before you map to OneDrive fields.\n For more information, see Mapping data source fields. The\n OneDrive data source field names must exist in your OneDrive custom metadata.
\n TRUE to disable local groups information.
Provides the configuration information to connect\n to OneDrive as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to OneDrive as your data\n source.
" } }, "com.amazonaws.kendra#OneDriveUser": { @@ -9051,13 +9295,13 @@ "OneDriveUserList": { "target": "com.amazonaws.kendra#OneDriveUserList", "traits": { - "smithy.api#documentation": "A list of users whose documents should be indexed. Specify the\n user names in email format, for example,\n username@tenantdomain. If you need to index the\n documents of more than 100 users, use the\n OneDriveUserS3Path field to specify the location of\n a file containing a list of users.
A list of users whose documents should be indexed. Specify the user names in email\n format, for example, username@tenantdomain. If you need to index the\n documents of more than 100 users, use the OneDriveUserS3Path field to\n specify the location of a file containing a list of users.
The S3 bucket location of a file containing a list of users whose\n documents should be indexed.
" + "smithy.api#documentation": "The S3 bucket location of a file containing a list of users whose documents should be\n indexed.
" } } }, @@ -9066,18 +9310,20 @@ } }, "com.amazonaws.kendra#Order": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASCENDING", - "name": "ASCENDING" - }, - { - "value": "DESCENDING", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" } - ] + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } } }, "com.amazonaws.kendra#OrganizationId": { @@ -9101,18 +9347,20 @@ } }, "com.amazonaws.kendra#Persona": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OWNER", - "name": "OWNER" - }, - { - "value": "VIEWER", - "name": "VIEWER" + "type": "enum", + "members": { + "OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OWNER" } - ] + }, + "VIEWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIEWER" + } + } } }, "com.amazonaws.kendra#PersonasSummary": { @@ -9121,13 +9369,13 @@ "EntityId": { "target": "com.amazonaws.kendra#EntityId", "traits": { - "smithy.api#documentation": "The identifier of a user or group in your Amazon Web Services SSO identity source. \n For example, a user ID could be an email.
" + "smithy.api#documentation": "The identifier of a user or group in your IAM Identity Center identity source. \n For example, a user ID could be an email.
" } }, "Persona": { "target": "com.amazonaws.kendra#Persona", "traits": { - "smithy.api#documentation": "The persona that defines the specific permissions of the user or group in \n your Amazon Web Services SSO identity source. The available personas or access \n roles are Owner and Viewer. For more information on \n these personas, see Providing \n access to your search page.
The persona that defines the specific permissions of the user or group in \n your IAM Identity Center identity source. The available personas or access \n roles are Owner and Viewer. For more information on \n these personas, see Providing \n access to your search page.
Summary information for users or groups in your Amazon Web Services SSO identity \n source. This applies to users and groups with specific permissions that define \n their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search application \n experience, see Building a \n search experience with no code.
" + "smithy.api#documentation": "Summary information for users or groups in your IAM Identity Center identity \n source. This applies to users and groups with specific permissions that define \n their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search application \n experience, see Building a \n search experience with no code.
" } }, "com.amazonaws.kendra#PersonasSummaryList": { @@ -9156,7 +9404,6 @@ "com.amazonaws.kendra#Port": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 65535 @@ -9190,12 +9437,12 @@ "DataSourceId": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the data source the principal should \n access documents from.
" + "smithy.api#documentation": "The identifier of the data source the principal should access documents from.
" } } }, "traits": { - "smithy.api#documentation": "Provides user and group information for user context filtering.
" + "smithy.api#documentation": "Provides user and group information for user context\n filtering.
" } }, "com.amazonaws.kendra#PrincipalList": { @@ -9205,30 +9452,38 @@ } }, "com.amazonaws.kendra#PrincipalMappingStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } } }, "com.amazonaws.kendra#PrincipalName": { @@ -9244,7 +9499,6 @@ "com.amazonaws.kendra#PrincipalOrderingId": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 32535158400000 @@ -9252,18 +9506,20 @@ } }, "com.amazonaws.kendra#PrincipalType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USER", - "name": "USER" - }, - { - "value": "GROUP", - "name": "GROUP" + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" } - ] + } } }, "com.amazonaws.kendra#PrivateChannelFilter": { @@ -9429,7 +9685,6 @@ "com.amazonaws.kendra#QueryCapacityUnit": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -9446,18 +9701,20 @@ } }, "com.amazonaws.kendra#QueryIdentifiersEnclosingOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DOUBLE_QUOTES", - "name": "DOUBLE_QUOTES" - }, - { - "value": "NONE", - "name": "NONE" + "type": "enum", + "members": { + "DOUBLE_QUOTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE_QUOTES" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" } - ] + } } }, "com.amazonaws.kendra#QueryRequest": { @@ -9660,22 +9917,26 @@ } }, "com.amazonaws.kendra#QueryResultType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DOCUMENT", - "name": "DOCUMENT" - }, - { - "value": "QUESTION_ANSWER", - "name": "QUESTION_ANSWER" - }, - { - "value": "ANSWER", - "name": "ANSWER" + "type": "enum", + "members": { + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "QUESTION_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUESTION_ANSWER" + } + }, + "ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANSWER" } - ] + } } }, "com.amazonaws.kendra#QuerySuggestionsBlockListId": { @@ -9695,38 +9956,48 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.kendra#QuerySuggestionsBlockListStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "ACTIVE_BUT_UPDATE_FAILED", - "name": "ACTIVE_BUT_UPDATE_FAILED" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.kendra#QuerySuggestionsBlockListStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "ACTIVE_BUT_UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_BUT_UPDATE_FAILED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.kendra#QuerySuggestionsBlockListSummary": { @@ -9789,18 +10060,20 @@ } }, "com.amazonaws.kendra#QuerySuggestionsStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "UPDATING", - "name": "UPDATING" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" } - ] + } } }, "com.amazonaws.kendra#QueryText": { @@ -9832,18 +10105,21 @@ "CrawlFileComments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to index file comments.
\n TRUE to index the contents of chat rooms.
\n TRUE to index attachments.
Indicates that this field determines how \"fresh\" a document is.\n For example, if document 1 was created on November 5, and document 2\n was created on October 31, document 1 is \"fresher\" than document 2.\n You can only set the Freshness field on one\n DATE type field. Only applies to DATE\n fields.
Indicates that this field determines how \"fresh\" a document is. For example, if\n document 1 was created on November 5, and document 2 was created on October 31, document\n 1 is \"fresher\" than document 2. You can only set the Freshness field on one\n DATE type field. Only applies to DATE fields.
The relative importance of the field in the search. Larger numbers\n provide more of a boost than smaller numbers.
" + "smithy.api#documentation": "The relative importance of the field in the search. Larger numbers provide more of a\n boost than smaller numbers.
" } }, "Duration": { "target": "com.amazonaws.kendra#Duration", "traits": { - "smithy.api#documentation": "Specifies the time period that the boost applies to. For example,\n to make the boost apply to documents with the field value within the\n last month, you would use \"2628000s\". Once the field value is beyond\n the specified range, the effect of the boost drops off. The higher\n the importance, the faster the effect drops off. If you don't\n specify a value, the default is 3 months. The value of the field is\n a numeric string followed by the character \"s\", for example \"86400s\"\n for one day, or \"604800s\" for one week.
\nOnly applies to DATE fields.
Specifies the time period that the boost applies to. For example, to make the boost\n apply to documents with the field value within the last month, you would use \"2628000s\".\n Once the field value is beyond the specified range, the effect of the boost drops off.\n The higher the importance, the faster the effect drops off. If you don't specify a\n value, the default is 3 months. The value of the field is a numeric string followed by\n the character \"s\", for example \"86400s\" for one day, or \"604800s\" for one week.
\nOnly applies to DATE fields.
Determines how values should be interpreted.
\nWhen the RankOrder field is ASCENDING,\n higher numbers are better. For example, a document with a rating\n score of 10 is higher ranking than a document with a rating score of\n 1.
When the RankOrder field is DESCENDING,\n lower numbers are better. For example, in a task tracking\n application, a priority 1 task is more important than a priority 5\n task.
Only applies to LONG and DOUBLE\n fields.
Determines how values should be interpreted.
\nWhen the RankOrder field is ASCENDING, higher numbers are\n better. For example, a document with a rating score of 10 is higher ranking than a\n document with a rating score of 1.
When the RankOrder field is DESCENDING, lower numbers are\n better. For example, in a task tracking application, a priority 1 task is more important\n than a priority 5 task.
Only applies to LONG and DOUBLE fields.
A list of values that should be given a different boost when they\n appear in the result list. For example, if you are boosting a field\n called \"department,\" query terms that match the department field are\n boosted in the result. However, you can add entries from the\n department field to boost documents with those values higher.
\nFor example, you can add entries to the map with names of\n departments. If you add \"HR\",5 and \"Legal\",3 those departments are\n given special attention when they appear in the metadata of a\n document. When those terms appear they are given the specified\n importance instead of the regular importance for the boost.
" + "smithy.api#documentation": "A list of values that should be given a different boost when they appear in the result\n list. For example, if you are boosting a field called \"department,\" query terms that\n match the department field are boosted in the result. However, you can add entries from\n the department field to boost documents with those values higher.
\nFor example, you can add entries to the map with names of departments. If you add\n \"HR\",5 and \"Legal\",3 those departments are given special attention when they appear in\n the metadata of a document. When those terms appear they are given the specified\n importance instead of the regular importance for the boost.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for tuning the relevance of a field\n in a search. When a query includes terms that match the field, the\n results are given a boost in the response based on these tuning\n parameters.
" + "smithy.api#documentation": "Provides information for tuning the relevance of a field in a search. When a query\n includes terms that match the field, the results are given a boost in the response based\n on these tuning parameters.
" } }, "com.amazonaws.kendra#RelevanceFeedback": { @@ -9953,20 +10231,20 @@ "ResultId": { "target": "com.amazonaws.kendra#ResultId", "traits": { - "smithy.api#documentation": "The unique identifier of the search result that the user provided\n relevance feedback for.
", + "smithy.api#documentation": "The unique identifier of the search result that the user provided relevance feedback\n for.
", "smithy.api#required": {} } }, "RelevanceValue": { "target": "com.amazonaws.kendra#RelevanceType", "traits": { - "smithy.api#documentation": "Whether to document was relevant or not relevant to the\n search.
", + "smithy.api#documentation": "Whether to document was relevant or not relevant to the search.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides feedback on how relevant a document is to a search. Your\n application uses the SubmitFeedback API to\n provide relevance information.
Provides feedback on how relevant a document is to a search. Your application uses the\n SubmitFeedback API to provide relevance information.
A list of S3 prefixes for the documents that should be included in\n the index.
" + "smithy.api#documentation": "A list of S3 prefixes for the documents that should be included in the index.
" } }, "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of glob patterns for documents that should be indexed. If a\n document that matches an inclusion pattern also matches an exclusion\n pattern, the document is not indexed.
\nSome examples \n are:
\n\n *.txt will include all text files \n in a directory (files with the extension .txt).
\n\n **/*.txt will include all text \n files in a directory and its subdirectories.
\n\n *tax* will include all files in \n a directory that contain 'tax' in the file name, such as 'tax', \n 'taxes', 'income_tax'.
\nA list of glob patterns for documents that should be indexed. If a document that\n matches an inclusion pattern also matches an exclusion pattern, the document is not\n indexed.
\nSome examples\n are:
\n\n *.txt will include all text files in a directory (files\n with the extension .txt).
\n\n **/*.txt will include all text files in a directory and\n its subdirectories.
\n\n *tax* will include all files in a directory that contain\n 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.
\nA list of glob patterns for documents that should not be indexed.\n If a document that matches an inclusion prefix or inclusion pattern\n also matches an exclusion pattern, the document is not\n indexed.
\nSome examples \n are:
\n\n *.png , *.jpg will exclude \n all PNG and JPEG image files in a directory \n (files with the extensions .png and .jpg).
\n\n *internal* will exclude all \n files in a directory that contain 'internal' in the file name, \n such as 'internal', 'internal_only', 'company_internal'.
\n\n **/*internal* will exclude \n all internal-related files in a directory and its subdirectories.
\nA list of glob patterns for documents that should not be indexed. If a document that\n matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the\n document is not indexed.
\nSome examples\n are:
\n\n *.png , *.jpg will exclude all PNG and JPEG image files\n in a directory (files with the extensions .png and .jpg).
\n\n *internal* will exclude all files in a directory that\n contain 'internal' in the file name, such as 'internal', 'internal_only',\n 'company_internal'.
\n\n **/*internal* will exclude all internal-related files in\n a directory and its subdirectories.
\nProvides the path to the S3 bucket that contains the user context\n filtering files for the data source. For the format of the file, see\n Access control for S3 data sources.
" + "smithy.api#documentation": "Provides the path to the S3 bucket that contains the user context filtering files for\n the data source. For the format of the file, see Access control for S3 data\n sources.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to \n an Amazon S3 bucket.
" + "smithy.api#documentation": "Provides the configuration information to connect to an Amazon S3\n bucket.
" } }, "com.amazonaws.kendra#S3ObjectKey": { @@ -10157,7 +10437,7 @@ } }, "traits": { - "smithy.api#documentation": "Information required to find a specific file in an Amazon S3\n bucket.
" + "smithy.api#documentation": "Information required to find a specific file in an Amazon S3 bucket.
" } }, "com.amazonaws.kendra#SaaSConfiguration": { @@ -10188,14 +10468,14 @@ "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the column in the Salesforce FeedItem table that\n contains the content to index. Typically this is the\n Body column.
The name of the column in the Salesforce FeedItem table that contains the content to\n index. Typically this is the Body column.
The name of the column in the Salesforce FeedItem table that\n contains the title of the document. This is typically the\n Title column.
The name of the column in the Salesforce FeedItem table that contains the title of the\n document. This is typically the Title column.
Filters the documents in the feed based on status of the user.\n When you specify ACTIVE_USERS only documents from users\n who have an active account are indexed. When you specify\n STANDARD_USER only documents for Salesforce\n standard users are documented. You can specify both.
Filters the documents in the feed based on status of the user. When you specify\n ACTIVE_USERS only documents from users who have an active account are\n indexed. When you specify STANDARD_USER only documents for Salesforce\n standard users are documented. You can specify both.
The configuration information for syncing a Salesforce chatter feed. The\n contents of the object comes from the Salesforce FeedItem\n table.
" + "smithy.api#documentation": "The configuration information for syncing a Salesforce chatter feed. The contents of\n the object comes from the Salesforce FeedItem table.
" } }, "com.amazonaws.kendra#SalesforceChatterFeedIncludeFilterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE_USER", - "name": "ACTIVE_USER" - }, - { - "value": "STANDARD_USER", - "name": "STANDARD_USER" + "type": "enum", + "members": { + "ACTIVE_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_USER" + } + }, + "STANDARD_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_USER" } - ] + } } }, "com.amazonaws.kendra#SalesforceChatterFeedIncludeFilterTypes": { @@ -10248,14 +10530,14 @@ "ServerUrl": { "target": "com.amazonaws.kendra#Url", "traits": { - "smithy.api#documentation": "The instance URL for the Salesforce site that you want to\n index.
", + "smithy.api#documentation": "The instance URL for the Salesforce site that you want to index.
", "smithy.api#required": {} } }, "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Managersecret\n that contains the key/value pairs required to connect to your\n Salesforce instance. The secret must contain a JSON structure with\n the following keys:
\nauthenticationUrl - The OAUTH endpoint that Amazon Kendra\n connects to get an OAUTH token.
\nconsumerKey - The application public key generated when\n you created your Salesforce application.
\nconsumerSecret - The application private key generated\n when you created your Salesforce application.
\npassword - The password associated with the user logging\n in to the Salesforce instance.
\nsecurityToken - The token associated with the user account\n logging in to the Salesforce instance.
\nusername - The user name of the user logging in to the\n Salesforce instance.
\nThe Amazon Resource Name (ARN) of an Secrets Managersecret that contains the\n key/value pairs required to connect to your Salesforce instance. The secret must contain\n a JSON structure with the following keys:
\nauthenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get\n an OAUTH token.
\nconsumerKey - The application public key generated when you created your\n Salesforce application.
\nconsumerSecret - The application private key generated when you created your\n Salesforce application.
\npassword - The password associated with the user logging in to the Salesforce\n instance.
\nsecurityToken - The token associated with the user account logging in to the\n Salesforce instance.
\nusername - The user name of the user logging in to the Salesforce\n instance.
\nConfiguration information for the knowledge article\n types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge\n articles and the standard fields of knowledge articles, or the\n custom fields of custom knowledge articles, but not both.
" + "smithy.api#documentation": "Configuration information for the knowledge article types that Amazon Kendra\n indexes. Amazon Kendra indexes standard knowledge articles and the standard fields\n of knowledge articles, or the custom fields of custom knowledge articles, but not\n both.
" } }, "ChatterFeedConfiguration": { @@ -10280,30 +10562,31 @@ "CrawlAttachments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether Amazon Kendra should index attachments to Salesforce\n objects.
" } }, "StandardObjectAttachmentConfiguration": { "target": "com.amazonaws.kendra#SalesforceStandardObjectAttachmentConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for processing attachments to\n Salesforce standard objects.
" + "smithy.api#documentation": "Configuration information for processing attachments to Salesforce standard objects.\n
" } }, "IncludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of regular expression patterns to include certain documents in your Salesforce.\n Documents that match the patterns are included in the index. Documents that\n don't match the patterns are excluded from the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.
\nThe pattern is applied to the name of the attached file.
" + "smithy.api#documentation": "A list of regular expression patterns to include certain documents in your Salesforce.\n Documents that match the patterns are included in the index. Documents that don't match\n the patterns are excluded from the index. If a document matches both an inclusion and\n exclusion pattern, the exclusion pattern takes precedence and the document isn't\n included in the index.
\nThe pattern is applied to the name of the attached file.
" } }, "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of regular expression patterns to exclude certain documents in your Salesforce.\n Documents that match the patterns are excluded from the index. Documents that\n don't match the patterns are included in the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.
\nThe pattern is applied to the name of the attached file.
" + "smithy.api#documentation": "A list of regular expression patterns to exclude certain documents in your Salesforce.\n Documents that match the patterns are excluded from the index. Documents that don't\n match the patterns are included in the index. If a document matches both an inclusion\n and exclusion pattern, the exclusion pattern takes precedence and the document isn't\n included in the index.
\nThe pattern is applied to the name of the attached file.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Salesforce\n as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Salesforce as your data\n source.
" } }, "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfiguration": { @@ -10319,25 +10602,25 @@ "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the field in the custom knowledge article that\n contains the document data to index.
", + "smithy.api#documentation": "The name of the field in the custom knowledge article that contains the document data\n to index.
", "smithy.api#required": {} } }, "DocumentTitleFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the field in the custom knowledge article that\n contains the document title.
" + "smithy.api#documentation": "The name of the field in the custom knowledge article that contains the document\n title.
" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "Maps attributes or field names of the custom knowledge article to Amazon Kendra \n index field names. To create custom fields, use the UpdateIndex API \n before you map to Salesforce fields. \n For more information, see Mapping data source fields. \n The Salesforce data source field names must exist in your Salesforce custom metadata.
Maps attributes or field names of the custom knowledge article to Amazon Kendra\n index field names. To create custom fields, use the UpdateIndex API before\n you map to Salesforce fields. For more information, see Mapping data source fields. The\n Salesforce data source field names must exist in your Salesforce custom metadata.
Provides the configuration information for indexing Salesforce custom\n articles.
" + "smithy.api#documentation": "Provides the configuration information for indexing Salesforce custom articles.
" } }, "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfigurationList": { @@ -10368,44 +10651,48 @@ "IncludedStates": { "target": "com.amazonaws.kendra#SalesforceKnowledgeArticleStateList", "traits": { - "smithy.api#documentation": "Specifies the document states that should be included when\n Amazon Kendra indexes knowledge articles. You must specify at least one\n state.
", + "smithy.api#documentation": "Specifies the document states that should be included when Amazon Kendra indexes\n knowledge articles. You must specify at least one state.
", "smithy.api#required": {} } }, "StandardKnowledgeArticleTypeConfiguration": { "target": "com.amazonaws.kendra#SalesforceStandardKnowledgeArticleTypeConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for standard Salesforce\n knowledge articles.
" + "smithy.api#documentation": "Configuration information for standard Salesforce knowledge articles.
" } }, "CustomKnowledgeArticleTypeConfigurations": { "target": "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfigurationList", "traits": { - "smithy.api#documentation": "Configuration information for custom Salesforce knowledge\n articles.
" + "smithy.api#documentation": "Configuration information for custom Salesforce knowledge articles.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for the knowledge article\n types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge\n articles and the standard fields of knowledge articles, or the\n custom fields of custom knowledge articles, but not both
" + "smithy.api#documentation": "Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the\n standard fields of knowledge articles, or the custom fields of custom knowledge\n articles, but not both
" } }, "com.amazonaws.kendra#SalesforceKnowledgeArticleState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DRAFT", - "name": "DRAFT" - }, - { - "value": "PUBLISHED", - "name": "PUBLISHED" - }, - { - "value": "ARCHIVED", - "name": "ARCHIVED" + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" } - ] + } } }, "com.amazonaws.kendra#SalesforceKnowledgeArticleStateList": { @@ -10426,7 +10713,7 @@ "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the field that contains the document data to\n index.
", + "smithy.api#documentation": "The name of the field that contains the document data to index.
", "smithy.api#required": {} } }, @@ -10439,12 +10726,12 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "Maps attributes or field names of the knowledge article to Amazon Kendra \n index field names. To create custom fields, use the UpdateIndex API \n before you map to Salesforce fields. \n For more information, see Mapping data source fields. \n The Salesforce data source field names must exist in your Salesforce custom metadata.
Maps attributes or field names of the knowledge article to Amazon Kendra index\n field names. To create custom fields, use the UpdateIndex API before you\n map to Salesforce fields. For more information, see Mapping data source fields. The\n Salesforce data source field names must exist in your Salesforce custom metadata.
Provides the configuration information for standard Salesforce\n knowledge articles.
" + "smithy.api#documentation": "Provides the configuration information for standard Salesforce knowledge\n articles.
" } }, "com.amazonaws.kendra#SalesforceStandardObjectAttachmentConfiguration": { @@ -10459,12 +10746,12 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "One or more objects that map fields in attachments to Amazon Kendra\n index fields.
" + "smithy.api#documentation": "One or more objects that map fields in attachments to Amazon Kendra index\n fields.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for processing attachments to\n Salesforce standard objects.
" + "smithy.api#documentation": "Provides the configuration information for processing attachments to Salesforce\n standard objects.
" } }, "com.amazonaws.kendra#SalesforceStandardObjectConfiguration": { @@ -10480,25 +10767,25 @@ "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the field in the standard object table that contains\n the document contents.
", + "smithy.api#documentation": "The name of the field in the standard object table that contains the document\n contents.
", "smithy.api#required": {} } }, "DocumentTitleFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the field in the standard object table that contains\n the document title.
" + "smithy.api#documentation": "The name of the field in the standard object table that contains the document\n title.
" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "Maps attributes or field names of the standard object to Amazon Kendra \n index field names. To create custom fields, use the UpdateIndex API \n before you map to Salesforce fields. \n For more information, see Mapping data source fields. \n The Salesforce data source field names must exist in your Salesforce custom metadata.
Maps attributes or field names of the standard object to Amazon Kendra index\n field names. To create custom fields, use the UpdateIndex API before you\n map to Salesforce fields. For more information, see Mapping data source fields. The\n Salesforce data source field names must exist in your Salesforce custom metadata.
Provides the configuration information for indexing a single standard\n object.
" + "smithy.api#documentation": "Provides the configuration information for indexing a single standard object.
" } }, "com.amazonaws.kendra#SalesforceStandardObjectConfigurationList": { @@ -10514,78 +10801,110 @@ } }, "com.amazonaws.kendra#SalesforceStandardObjectName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACCOUNT", - "name": "ACCOUNT" - }, - { - "value": "CAMPAIGN", - "name": "CAMPAIGN" - }, - { - "value": "CASE", - "name": "CASE" - }, - { - "value": "CONTACT", - "name": "CONTACT" - }, - { - "value": "CONTRACT", - "name": "CONTRACT" - }, - { - "value": "DOCUMENT", - "name": "DOCUMENT" - }, - { - "value": "GROUP", - "name": "GROUP" - }, - { - "value": "IDEA", - "name": "IDEA" - }, - { - "value": "LEAD", - "name": "LEAD" - }, - { - "value": "OPPORTUNITY", - "name": "OPPORTUNITY" - }, - { - "value": "PARTNER", - "name": "PARTNER" - }, - { - "value": "PRICEBOOK", - "name": "PRICEBOOK" - }, - { - "value": "PRODUCT", - "name": "PRODUCT" - }, - { - "value": "PROFILE", - "name": "PROFILE" - }, - { - "value": "SOLUTION", - "name": "SOLUTION" - }, - { - "value": "TASK", - "name": "TASK" - }, - { - "value": "USER", - "name": "USER" - } - ] + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "CAMPAIGN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAMPAIGN" + } + }, + "CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE" + } + }, + "CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT" + } + }, + "CONTRACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRACT" + } + }, + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + }, + "IDEA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDEA" + } + }, + "LEAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAD" + } + }, + "OPPORTUNITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPPORTUNITY" + } + }, + "PARTNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTNER" + } + }, + "PRICEBOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRICEBOOK" + } + }, + "PRODUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCT" + } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + }, + "SOLUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLUTION" + } + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK" + } + }, + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + } } }, "com.amazonaws.kendra#ScanSchedule": { @@ -10606,31 +10925,41 @@ } }, "com.amazonaws.kendra#ScoreConfidence": { - "type": "string", + "type": "enum", + "members": { + "VERY_HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERY_HIGH" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } + }, "traits": { - "smithy.api#documentation": "Enumeration for query score confidence.", - "smithy.api#enum": [ - { - "value": "VERY_HIGH", - "name": "VERY_HIGH" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "MEDIUM", - "name": "MEDIUM" - }, - { - "value": "LOW", - "name": "LOW" - }, - { - "value": "NOT_AVAILABLE", - "name": "NOT_AVAILABLE" - } - ] + "smithy.api#documentation": "Enumeration for query score confidence." } }, "com.amazonaws.kendra#Search": { @@ -10639,30 +10968,34 @@ "Facetable": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "Indicates that the field can be used to create search facets, a\n count of results for each value in the field. The default is\n false .
Indicates that the field can be used to create search facets, a count of results for\n each value in the field. The default is false .
Determines whether the field is used in the search. If the\n Searchable field is true, you can use\n relevance tuning to manually tune how Amazon Kendra weights the field in\n the search. The default is true for string fields and\n false for number and date fields.
Determines whether the field is used in the search. If the Searchable\n field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for\n string fields and false for number and date fields.
Determines whether the field is returned in the query response.\n The default is true.
Determines whether the field is returned in the query response. The default is\n true.
Determines whether the field can be used to sort the results of a\n query. If you specify sorting on a field that does not have\n Sortable set to true, Amazon Kendra returns an\n exception. The default is false.
Determines whether the field can be used to sort the results of a query. If you\n specify sorting on a field that does not have Sortable set to\n true, Amazon Kendra returns an exception. The default is\n false.
Provides information about how a custom index field is used during\n a search.
" + "smithy.api#documentation": "Provides information about how a custom index field is used during a search.
" } }, "com.amazonaws.kendra#SecretArn": { @@ -10736,42 +11069,46 @@ "KmsKeyId": { "target": "com.amazonaws.kendra#KmsKeyId", "traits": { - "smithy.api#documentation": "The identifier of the KMS key. Amazon Kendra\n doesn't support asymmetric keys.
" + "smithy.api#documentation": "The identifier of the KMS key. Amazon Kendra doesn't support\n asymmetric keys.
" } } }, "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to \n encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't \n support asymmetric keys.
" + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt data\n indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric\n keys.
" } }, "com.amazonaws.kendra#ServiceNowAuthenticationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HTTP_BASIC", - "name": "HTTP_BASIC" - }, - { - "value": "OAUTH2", - "name": "OAUTH2" + "type": "enum", + "members": { + "HTTP_BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_BASIC" + } + }, + "OAUTH2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2" } - ] + } } }, "com.amazonaws.kendra#ServiceNowBuildVersionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LONDON", - "name": "LONDON" - }, - { - "value": "OTHERS", - "name": "OTHERS" + "type": "enum", + "members": { + "LONDON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONDON" + } + }, + "OTHERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHERS" } - ] + } } }, "com.amazonaws.kendra#ServiceNowConfiguration": { @@ -10780,45 +11117,45 @@ "HostUrl": { "target": "com.amazonaws.kendra#ServiceNowHostUrl", "traits": { - "smithy.api#documentation": "The ServiceNow instance that the data source connects to. The host\n endpoint should look like the following:\n {instance}.service-now.com.\n
", + "smithy.api#documentation": "The ServiceNow instance that the data source connects to. The host endpoint should\n look like the following: {instance}.service-now.com.\n
", "smithy.api#required": {} } }, "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Secrets Manager secret\n that contains the user name and password required to connect to the\n ServiceNow instance. You can also provide OAuth authentication credentials \n of user name, password, client ID, and client secret. For more information, \n see Authentication \n for a ServiceNow data source.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the\n user name and password required to connect to the ServiceNow instance. You can also\n provide OAuth authentication credentials of user name, password, client ID, and client\n secret. For more information, see Authentication for a ServiceNow data source.
", "smithy.api#required": {} } }, "ServiceNowBuildVersion": { "target": "com.amazonaws.kendra#ServiceNowBuildVersionType", "traits": { - "smithy.api#documentation": "The identifier of the release that the ServiceNow host is running.\n If the host is not running the LONDON release, use\n OTHERS.
The identifier of the release that the ServiceNow host is running. If the host is not\n running the LONDON release, use OTHERS.
Configuration information for crawling knowledge articles\n in the ServiceNow site.
" + "smithy.api#documentation": "Configuration information for crawling knowledge articles in the ServiceNow\n site.
" } }, "ServiceCatalogConfiguration": { "target": "com.amazonaws.kendra#ServiceNowServiceCatalogConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for crawling service catalogs\n in the ServiceNow site.
" + "smithy.api#documentation": "Configuration information for crawling service catalogs in the ServiceNow site.
" } }, "AuthenticationType": { "target": "com.amazonaws.kendra#ServiceNowAuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the \n Secrets Manager secret in the SecretArn field. If you\n choose OAUTH2, Amazon Kendra is authenticated using the \n credentials of client ID, client secret, user name and password.
When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.
The type of authentication used to connect to the ServiceNow instance. If you choose\n HTTP_BASIC, Amazon Kendra is authenticated using the user name and\n password provided in the Secrets Manager secret in the SecretArn\n field. If you choose OAUTH2, Amazon Kendra is authenticated using the\n credentials of client ID, client secret, user name and password.
When you use OAUTH2 authentication, you must generate a token and a\n client secret using the ServiceNow console. For more information, see Using a\n ServiceNow data source.
Provides the configuration information to connect to \n ServiceNow as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to ServiceNow as your data\n source.
" } }, "com.amazonaws.kendra#ServiceNowHostUrl": { @@ -10837,49 +11174,50 @@ "CrawlAttachments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to index attachments to knowledge articles.
A list of regular expression patterns to include certain attachments of knowledge articles in \n your ServiceNow. Item that match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.
\nThe regex is\n applied to the field specified in the PatternTargetField.
A list of regular expression patterns to include certain attachments of knowledge\n articles in your ServiceNow. Item that match the patterns are included in the index.\n Items that don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item\n isn't included in the index.
\nThe regex is applied to the field specified in the\n PatternTargetField.
A list of regular expression patterns to exclude certain attachments of knowledge articles in \n your ServiceNow. Item that match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.
\nThe regex is\n applied to the field specified in the PatternTargetField.
A list of regular expression patterns to exclude certain attachments of knowledge\n articles in your ServiceNow. Item that match the patterns are excluded from the index.\n Items that don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item\n isn't included in the index.
\nThe regex is applied to the field specified in the\n PatternTargetField.
The name of the ServiceNow field that is mapped to the index\n document contents field in the Amazon Kendra index.
", + "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index document contents field\n in the Amazon Kendra index.
", "smithy.api#required": {} } }, "DocumentTitleFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index\n document title field.
" + "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index document title\n field.
" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "Maps attributes or field names of knoweldge articles to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex API before \n you map to ServiceNow fields. \n For more information, see Mapping data source fields. \n The ServiceNow data source field names must exist in your ServiceNow custom metadata.
Maps attributes or field names of knoweldge articles to Amazon Kendra index field\n names. To create custom fields, use the UpdateIndex API before you map to\n ServiceNow fields. For more information, see Mapping data source fields. The\n ServiceNow data source field names must exist in your ServiceNow custom metadata.
A query that selects the knowledge articles to index. The query\n can return articles from multiple knowledge bases, and the knowledge\n bases can be public or private.
\nThe query string must be one generated by the ServiceNow console.\n For more information, see Specifying\n documents to index with a query.
" + "smithy.api#documentation": "A query that selects the knowledge articles to index. The query can return articles\n from multiple knowledge bases, and the knowledge bases can be public or private.
\nThe query string must be one generated by the ServiceNow console. For more\n information, see Specifying documents to index with a\n query.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for crawling knowledge articles\n in the ServiceNow site.
" + "smithy.api#documentation": "Provides the configuration information for crawling knowledge articles in the\n ServiceNow site.
" } }, "com.amazonaws.kendra#ServiceNowKnowledgeArticleFilterQuery": { @@ -10898,43 +11236,44 @@ "CrawlAttachments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to index attachments to service catalog items.
A list of regular expression patterns to include certain attachments of catalogs in \n your ServiceNow. Item that match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.
\nThe regex is applied to the file name of the attachment.
" + "smithy.api#documentation": "A list of regular expression patterns to include certain attachments of catalogs in\n your ServiceNow. Item that match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both an\n inclusion and exclusion pattern, the exclusion pattern takes precedence and the item\n isn't included in the index.
\nThe regex is applied to the file name of the attachment.
" } }, "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of regular expression patterns to exclude certain attachments of catalogs in \n your ServiceNow. Item that match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.
\nThe regex is applied to the file name of the attachment.
" + "smithy.api#documentation": "A list of regular expression patterns to exclude certain attachments of catalogs in\n your ServiceNow. Item that match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both an inclusion\n and exclusion pattern, the exclusion pattern takes precedence and the item isn't\n included in the index.
\nThe regex is applied to the file name of the attachment.
" } }, "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index\n document contents field in the Amazon Kendra index.
", + "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index document contents field\n in the Amazon Kendra index.
", "smithy.api#required": {} } }, "DocumentTitleFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index\n document title field.
" + "smithy.api#documentation": "The name of the ServiceNow field that is mapped to the index document title\n field.
" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "Maps attributes or field names of catalogs to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex API before \n you map to ServiceNow fields. \n For more information, see Mapping data source fields. \n The ServiceNow data source field names must exist in your ServiceNow custom metadata.
Maps attributes or field names of catalogs to Amazon Kendra index field names. To\n create custom fields, use the UpdateIndex API before you map to ServiceNow\n fields. For more information, see Mapping data source fields. The\n ServiceNow data source field names must exist in your ServiceNow custom metadata.
Provides the configuration information for crawling service catalog\n items in the ServiceNow site
" + "smithy.api#documentation": "Provides the configuration information for crawling service catalog items in the\n ServiceNow site
" } }, "com.amazonaws.kendra#ServiceQuotaExceededException": { @@ -10970,94 +11309,99 @@ "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Manager \n secret that contains the user name and password required to \n connect to the SharePoint instance. \n If you use SharePoint Server, you also need to provide the sever \n domain name as part of the credentials. For\n more information, see Using a\n Microsoft SharePoint Data Source.
\nYou can also provide OAuth authentication credentials of user name, \n password, client ID, and client secret. For more information, see \n Authentication \n for a SharePoint data source.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the\n user name and password required to connect to the SharePoint instance. If you use\n SharePoint Server, you also need to provide the sever domain name as part of the\n credentials. For more information, see Using a Microsoft SharePoint Data\n Source.
\nYou can also provide OAuth authentication credentials of user name, password, client\n ID, and client secret. For more information, see Authentication for a SharePoint data source.
", "smithy.api#required": {} } }, "CrawlAttachments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to index document attachments.
\n TRUE to use the SharePoint change log to determine which documents\n require updating in the index. Depending on the change log's\n size, it may take longer for Amazon Kendra to use the change log than to \n scan all of your documents in SharePoint.
\n TRUE to use the SharePoint change log to determine which documents\n require updating in the index. Depending on the change log's size, it may take longer\n for Amazon Kendra to use the change log than to scan all of your documents in\n SharePoint.
A list of regular expression patterns to include certain documents in your SharePoint.\n Documents that match the patterns are included in the index. Documents that\n don't match the patterns are excluded from the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.
\nThe regex applies to the display URL of the SharePoint\n document.
" + "smithy.api#documentation": "A list of regular expression patterns to include certain documents in your SharePoint.\n Documents that match the patterns are included in the index. Documents that don't match\n the patterns are excluded from the index. If a document matches both an inclusion and\n exclusion pattern, the exclusion pattern takes precedence and the document isn't\n included in the index.
\nThe regex applies to the display URL of the SharePoint document.
" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "A list of regular expression patterns to exclude certain documents in your SharePoint.\n Documents that match the patterns are excluded from the index. Documents that\n don't match the patterns are included in the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.
\nThe regex applies to the display URL of the SharePoint\n document.
" + "smithy.api#documentation": "A list of regular expression patterns to exclude certain documents in your SharePoint.\n Documents that match the patterns are excluded from the index. Documents that don't\n match the patterns are included in the index. If a document matches both an inclusion\n and exclusion pattern, the exclusion pattern takes precedence and the document isn't\n included in the index.
\nThe regex applies to the display URL of the SharePoint document.
" } }, "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect \n to your Microsoft SharePoint. For more information, see \n Configuring \n a VPC.
" + "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft\n SharePoint. For more information, see Configuring a VPC.
" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map SharePoint data \n source attributes or field names to Amazon Kendra index field names. To create \n custom fields, use the UpdateIndex API before you map to SharePoint fields. \n For more information, see Mapping data source fields. \n The SharePoint data source field names must exist in your SharePoint custom metadata.
A list of DataSourceToIndexFieldMapping objects that map SharePoint data\n source attributes or field names to Amazon Kendra index field names. To create\n custom fields, use the UpdateIndex API before you map to SharePoint fields.\n For more information, see Mapping data source fields. The\n SharePoint data source field names must exist in your SharePoint custom metadata.
The Microsoft SharePoint attribute field that contains the title\n of the document.
" + "smithy.api#documentation": "The Microsoft SharePoint attribute field that contains the title of the\n document.
" } }, "DisableLocalGroups": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to disable local groups information.
The path to the SSL certificate stored in an Amazon S3 bucket. You \n use this to connect to SharePoint Server if you require a secure SSL \n connection.
\nYou can simply generate a self-signed X509 certificate on any computer using \n OpenSSL. For an example of using OpenSSL to create an X509 certificate, see \n Create and sign \n an X509 certificate.
" + "smithy.api#documentation": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to\n connect to SharePoint Server if you require a secure SSL connection.
\nYou can simply generate a self-signed X509 certificate on any computer using OpenSSL.\n For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
" } }, "AuthenticationType": { "target": "com.amazonaws.kendra#SharePointOnlineAuthenticationType", "traits": { - "smithy.api#documentation": "Whether you want to connect to SharePoint using basic authentication of \n user name and password, or OAuth authentication of user name, password, \n client ID, and client secret. You can use OAuth authentication for \n SharePoint Online.
" + "smithy.api#documentation": "Whether you want to connect to SharePoint using basic authentication of user name and\n password, or OAuth authentication of user name, password, client ID, and client secret.\n You can use OAuth authentication for SharePoint Online.
" } }, "ProxyConfiguration": { "target": "com.amazonaws.kendra#ProxyConfiguration", "traits": { - "smithy.api#documentation": "Configuration information to connect to your Microsoft SharePoint site URLs \n via instance via a web proxy. You can use this option for SharePoint Server.
\nYou must provide the website host name and port number. For example, the host name of \n https://a.example.com/page1.html is \"a.example.com\" and the port \n is 443, the standard port for HTTPS.
\nWeb proxy credentials are optional and you can use them to connect to a web proxy \n server that requires basic authentication of user name and password. To store web \n proxy credentials, you use a secret in Secrets Manager.
\nIt is recommended that you follow best security practices when configuring your \n web proxy. This includes setting up throttling, setting up logging and monitoring, \n and applying security patches on a regular basis. If you use your web proxy with \n multiple data sources, sync jobs that occur at the same time could strain the load \n on your proxy. It is recommended you prepare your proxy beforehand for any security \n and load requirements.
" + "smithy.api#documentation": "Configuration information to connect to your Microsoft SharePoint site URLs via\n instance via a web proxy. You can use this option for SharePoint Server.
\nYou must provide the website host name and port number. For example, the host name of\n https://a.example.com/page1.html is \"a.example.com\" and the\n port is 443, the standard port for HTTPS.
\nWeb proxy credentials are optional and you can use them to connect to a web proxy\n server that requires basic authentication of user name and password. To store web proxy\n credentials, you use a secret in Secrets Manager.
\nIt is recommended that you follow best security practices when configuring your web\n proxy. This includes setting up throttling, setting up logging and monitoring, and\n applying security patches on a regular basis. If you use your web proxy with multiple\n data sources, sync jobs that occur at the same time could strain the load on your proxy.\n It is recommended you prepare your proxy beforehand for any security and load\n requirements.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to connect to Microsoft\n SharePoint as your data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Microsoft SharePoint as your data\n source.
" } }, "com.amazonaws.kendra#SharePointOnlineAuthenticationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HTTP_BASIC", - "name": "HTTP_BASIC" - }, - { - "value": "OAUTH2", - "name": "OAUTH2" + "type": "enum", + "members": { + "HTTP_BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_BASIC" + } + }, + "OAUTH2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2" } - ] + } } }, "com.amazonaws.kendra#SharePointUrlList": { @@ -11073,26 +11417,32 @@ } }, "com.amazonaws.kendra#SharePointVersion": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SHAREPOINT_2013", - "name": "SHAREPOINT_2013" - }, - { - "value": "SHAREPOINT_2016", - "name": "SHAREPOINT_2016" - }, - { - "value": "SHAREPOINT_ONLINE", - "name": "SHAREPOINT_ONLINE" - }, - { - "value": "SHAREPOINT_2019", - "name": "SHAREPOINT_2019" - } - ] + "type": "enum", + "members": { + "SHAREPOINT_2013": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT_2013" + } + }, + "SHAREPOINT_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT_2016" + } + }, + "SHAREPOINT_ONLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT_ONLINE" + } + }, + "SHAREPOINT_2019": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT_2019" + } + } } }, "com.amazonaws.kendra#SharedDriveId": { @@ -11205,18 +11555,21 @@ "UseChangeLog": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to use the Slack change log to determine which documents\n require updating in the index. Depending on the Slack change log's\n size, it may take longer for Amazon Kendra to use the change log than to \n scan all of your documents in Slack.
\n TRUE to index bot messages from your Slack workspace team.
\n TRUE to exclude archived messages to index from your Slack \n workspace team.
The name of the document attribute used to sort the response. You\n can use any field that has the Sortable flag set to\n true.
You can also sort by any of the following built-in\n attributes:
\n_category
\n_created_at
\n_last_updated_at
\n_version
\n_view_count
\nThe name of the document attribute used to sort the response. You can use any field\n that has the Sortable flag set to true.
You can also sort by any of the following built-in attributes:
\n_category
\n_created_at
\n_last_updated_at
\n_version
\n_view_count
\nThe order that the results should be returned in. In case of ties,\n the relevance assigned to the result by Amazon Kendra is used as the\n tie-breaker.
", + "smithy.api#documentation": "The order that the results should be returned in. In case of ties, the relevance\n assigned to the result by Amazon Kendra is used as the tie-breaker.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the document attribute to use to sort the response to a\n Amazon Kendra query. You can specify a single attribute for sorting. The\n attribute must have the Sortable flag set to\n true, otherwise Amazon Kendra returns an exception.
You can sort attributes of the following types.
\nDate value
\nLong value
\nString value
\nYou can't sort attributes of the following type.
\nString list value
\nSpecifies the document attribute to use to sort the response to a Amazon Kendra\n query. You can specify a single attribute for sorting. The attribute must have the\n Sortable flag set to true, otherwise Amazon Kendra\n returns an exception.
You can sort attributes of the following types.
\nDate value
\nLong value
\nString value
\nYou can't sort attributes of the following type.
\nString list value
\n\n TRUE to suggest spell corrections for queries.
Determines whether Amazon Kendra encloses SQL identifiers for tables and\n column names in double quotes (\") when making a database\n query.
\nBy default, Amazon Kendra passes SQL identifiers the way that they are\n entered into the data source configuration. It does not change the\n case of identifiers or enclose them in quotes.
\nPostgreSQL internally converts uppercase characters to lower case\n characters in identifiers unless they are quoted. Choosing this\n option encloses identifiers in quotes so that PostgreSQL does not\n convert the character's case.
\nFor MySQL databases, you must enable the ansi_quotes\n option when you set this field to DOUBLE_QUOTES.
Determines whether Amazon Kendra encloses SQL identifiers for tables and column\n names in double quotes (\") when making a database query.
\nBy default, Amazon Kendra passes SQL identifiers the way that they are entered\n into the data source configuration. It does not change the case of identifiers or\n enclose them in quotes.
\nPostgreSQL internally converts uppercase characters to lower case characters in\n identifiers unless they are quoted. Choosing this option encloses identifiers in quotes\n so that PostgreSQL does not convert the character's case.
\nFor MySQL databases, you must enable the ansi_quotes option when you set\n this field to DOUBLE_QUOTES.
Provides the configuration information to use a SQL\n database.
" + "smithy.api#documentation": "Provides the configuration information to use a SQL database.
" } }, "com.amazonaws.kendra#StartDataSourceSyncJob": { @@ -11445,7 +11807,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a synchronization job for a data source connector. If a synchronization\n job is already in progress, Amazon Kendra returns a\n ResourceInUseException exception.
Starts a synchronization job for a data source connector. If a synchronization job is\n already in progress, Amazon Kendra returns a ResourceInUseException\n exception.
Stops a synchronization job that is currently running. \n You can't stop a scheduled synchronization job.
" + "smithy.api#documentation": "Stops a synchronization job that is currently running. You can't stop a scheduled\n synchronization job.
" } }, "com.amazonaws.kendra#StopDataSourceSyncJobRequest": { @@ -11545,7 +11907,7 @@ "Id": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the data source connector for which to stop the\n synchronization jobs.
", + "smithy.api#documentation": "The identifier of the data source connector for which to stop the synchronization\n jobs.
", "smithy.api#required": {} } }, @@ -11561,7 +11923,6 @@ "com.amazonaws.kendra#StorageCapacityUnit": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -11907,7 +12268,7 @@ "com.amazonaws.kendra#Template": { "type": "document", "traits": { - "smithy.api#documentation": "The template schema used for the data source.
\nThe following links to the template schema for data sources \n where templates are supported:
\nThe template schema used for the data source, where templates schemas are supported.
\nSee Data source template schemas.
" } }, "com.amazonaws.kendra#TemplateConfiguration": { @@ -11916,12 +12277,12 @@ "Template": { "target": "com.amazonaws.kendra#Template", "traits": { - "smithy.api#documentation": "The template schema used for the data source.
\nThe following links to the template schema for data sources \n where templates are supported:
\nThe template schema used for the data source, where templates schemas are supported.
\nSee Data source template schemas.
" } } }, "traits": { - "smithy.api#documentation": "Provides a template for the configuration information to connect \n to your data source.
" + "smithy.api#documentation": "Provides a template for the configuration information to connect to your data\n source.
" } }, "com.amazonaws.kendra#TenantDomain": { @@ -11940,6 +12301,7 @@ "IndexedTextDocumentsCount": { "target": "com.amazonaws.kendra#IndexedTextDocumentsCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of text documents indexed.
", "smithy.api#required": {} } @@ -11947,13 +12309,14 @@ "IndexedTextBytes": { "target": "com.amazonaws.kendra#IndexedTextBytes", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total size, in bytes, of the indexed documents.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides information about text documents indexed in an\n index.
" + "smithy.api#documentation": "Provides information about text documents indexed in an index.
" } }, "com.amazonaws.kendra#TextWithHighlights": { @@ -11968,12 +12331,12 @@ "Highlights": { "target": "com.amazonaws.kendra#HighlightList", "traits": { - "smithy.api#documentation": "The beginning and end of the text that should be\n highlighted.
" + "smithy.api#documentation": "The beginning and end of the text that should be highlighted.
" } } }, "traits": { - "smithy.api#documentation": "Provides text and information about where to highlight the\n text.
" + "smithy.api#documentation": "Provides text and information about where to highlight the text.
" } }, "com.amazonaws.kendra#ThesaurusId": { @@ -11997,34 +12360,44 @@ } }, "com.amazonaws.kendra#ThesaurusStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "ACTIVE_BUT_UPDATE_FAILED", - "name": "ACTIVE_BUT_UPDATE_FAILED" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "ACTIVE_BUT_UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_BUT_UPDATE_FAILED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.kendra#ThesaurusSummary": { @@ -12123,6 +12496,7 @@ "com.amazonaws.kendra#TopDocumentAttributeValueCountPairsSize": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 5000 @@ -12130,18 +12504,20 @@ } }, "com.amazonaws.kendra#Type": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SAAS", - "name": "SAAS" - }, - { - "value": "ON_PREMISE", - "name": "ON_PREMISE" + "type": "enum", + "members": { + "SAAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAAS" } - ] + }, + "ON_PREMISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_PREMISE" + } + } } }, "com.amazonaws.kendra#UntagResource": { @@ -12342,7 +12718,7 @@ "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect to your \n data source. For more information, see Configuring a VPC.
" + "smithy.api#documentation": "Configuration information for an Amazon Virtual Private Cloud to connect to your data source.\n For more information, see Configuring a VPC.
" } }, "Description": { @@ -12360,7 +12736,7 @@ "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access \n the data source and required resources. For more information, see IAM roles for \n Amazon Kendra.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source and\n required resources. For more information, see IAM roles for Amazon Kendra.
" } }, "LanguageCode": { @@ -12435,7 +12811,7 @@ "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access Query\n API, QuerySuggestions API, SubmitFeedback\n API, and Amazon Web Services SSO that stores your user and group information. \n For more information, see IAM roles for Amazon Kendra.
The Amazon Resource Name (ARN) of a role with permission to access Query\n API, QuerySuggestions API, SubmitFeedback\n API, and IAM Identity Center that stores your user and group information. \n For more information, see IAM roles for Amazon Kendra.
Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" + "smithy.api#documentation": "Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" } } } @@ -12841,18 +13217,20 @@ } }, "com.amazonaws.kendra#UserContextPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ATTRIBUTE_FILTER", - "name": "ATTRIBUTE_FILTER" - }, - { - "value": "USER_TOKEN", - "name": "USER_TOKEN" + "type": "enum", + "members": { + "ATTRIBUTE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTRIBUTE_FILTER" } - ] + }, + "USER_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_TOKEN" + } + } } }, "com.amazonaws.kendra#UserGroupResolutionConfiguration": { @@ -12861,28 +13239,30 @@ "UserGroupResolutionMode": { "target": "com.amazonaws.kendra#UserGroupResolutionMode", "traits": { - "smithy.api#documentation": "The identity store provider (mode) you want to use to fetch access levels of groups and\n users. Amazon Web Services Single Sign On is currently the only available mode. Your users and groups\n must\n exist in an Amazon Web Services SSO identity source in order to use this mode.
", + "smithy.api#documentation": "The identity store provider (mode) you want to use to fetch access levels of groups and\n users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups\n must\n exist in an IAM Identity Center identity source in order to use this mode.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to fetch access levels \n of groups and users from an Amazon Web Services Single Sign On identity \n source. This is useful for user context filtering, where search \n results are filtered based on the user or their group access to \n documents. You can also use the PutPrincipalMapping \n API to map users to their groups so that you only need to provide \n the user ID when you issue the query.
\nTo set up an Amazon Web Services SSO identity source in the console to use with \n Amazon Kendra, see Getting started \n with an Amazon Web Services SSO identity source. You must also grant the required \n permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see \n IAM roles for \n Amazon Web Services SSO.
\nAmazon Kendra currently does not support using UserGroupResolutionConfiguration \n with an Amazon Web Services organization member account for your Amazon Web Services SSO \n identify source. You must create your index in the management account for the organization \n in order to use UserGroupResolutionConfiguration.
Provides the configuration information to fetch access levels \n of groups and users from an IAM Identity Center (successor to Single Sign-On) identity \n source. This is useful for user context filtering, where search \n results are filtered based on the user or their group access to \n documents. You can also use the PutPrincipalMapping \n API to map users to their groups so that you only need to provide \n the user ID when you issue the query.
\nTo set up an IAM Identity Center identity source in the console to use with \n Amazon Kendra, see Getting started \n with an IAM Identity Center identity source. You must also grant the required \n permissions to use IAM Identity Center with Amazon Kendra. For more information, see \n IAM roles for \n IAM Identity Center.
\nAmazon Kendra currently does not support using UserGroupResolutionConfiguration \n with an Amazon Web Services organization member account for your IAM Identity Center \n identify source. You must create your index in the management account for the organization \n in order to use UserGroupResolutionConfiguration.
The Amazon Web Services SSO field name that contains the identifiers of your users, \n such as their emails. This is used for user context filtering \n and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO \n with Amazon Kendra. You must include your users and groups in your Access Control List when \n you ingest documents into your index. For more information, see \n Getting \n started with an Amazon Web Services SSO identity source.
" + "smithy.api#documentation": "The IAM Identity Center field name that contains the identifiers of your users, \n such as their emails. This is used for user context filtering \n and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center \n with Amazon Kendra. You must include your users and groups in your Access Control List when \n you ingest documents into your index. For more information, see \n Getting \n started with an IAM Identity Center identity source.
" } } }, @@ -13023,14 +13403,14 @@ } }, "com.amazonaws.kendra#WarningCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "QUERY_LANGUAGE_INVALID_SYNTAX", - "name": "QUERY_LANGUAGE_INVALID_SYNTAX" + "type": "enum", + "members": { + "QUERY_LANGUAGE_INVALID_SYNTAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_LANGUAGE_INVALID_SYNTAX" } - ] + } } }, "com.amazonaws.kendra#WarningList": { @@ -13119,22 +13499,26 @@ } }, "com.amazonaws.kendra#WebCrawlerMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HOST_ONLY", - "name": "HOST_ONLY" - }, - { - "value": "SUBDOMAINS", - "name": "SUBDOMAINS" - }, - { - "value": "EVERYTHING", - "name": "EVERYTHING" + "type": "enum", + "members": { + "HOST_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOST_ONLY" + } + }, + "SUBDOMAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBDOMAINS" } - ] + }, + "EVERYTHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVERYTHING" + } + } } }, "com.amazonaws.kendra#WorkDocsConfiguration": { @@ -13150,12 +13534,14 @@ "CrawlComments": { "target": "com.amazonaws.kendra#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n TRUE to include comments on documents \n in your index. Including comments in your index means each comment \n is a document that can be searched on.
The default is set to FALSE.
\n TRUE to use the Amazon WorkDocs change log to determine \n which documents require updating in the index. Depending on the change log's\n size, it may take longer for Amazon Kendra to use the change log than to \n scan all of your documents in Amazon WorkDocs.
Indicates whether audio input is allowed.
", + "smithy.api#required": {} + } + }, + "allowDTMFInput": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether DTMF input is allowed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the allowed input types.
" + } + }, "com.amazonaws.lexmodelsv2#AmazonResourceName": { "type": "string", "traits": { @@ -243,18 +269,20 @@ } }, "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IntentId", - "name": "IntentId" - }, - { - "value": "SlotTypeId", - "name": "SlotTypeId" + "type": "enum", + "members": { + "IntentId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IntentId" + } + }, + "SlotTypeId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlotTypeId" } - ] + } } }, "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilters": { @@ -293,6 +321,33 @@ } } }, + "com.amazonaws.lexmodelsv2#AudioAndDTMFInputSpecification": { + "type": "structure", + "members": { + "startTimeoutMs": { + "target": "com.amazonaws.lexmodelsv2#TimeInMilliSeconds", + "traits": { + "smithy.api#documentation": "Time for which a bot waits before assuming that the customer isn't going to speak or press \n a key. This timeout is shared between Audio and DTMF inputs.
", + "smithy.api#required": {} + } + }, + "audioSpecification": { + "target": "com.amazonaws.lexmodelsv2#AudioSpecification", + "traits": { + "smithy.api#documentation": "Specifies the settings on audio input.
" + } + }, + "dtmfSpecification": { + "target": "com.amazonaws.lexmodelsv2#DTMFSpecification", + "traits": { + "smithy.api#documentation": "Specifies the settings on DTMF input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the audio and DTMF input specification.
" + } + }, "com.amazonaws.lexmodelsv2#AudioLogDestination": { "type": "structure", "members": { @@ -314,6 +369,7 @@ "enabled": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether audio logging in enabled for the bot.
", "smithy.api#required": {} } @@ -342,18 +398,43 @@ } }, "com.amazonaws.lexmodelsv2#AudioRecognitionStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UseSlotValuesAsCustomVocabulary", - "name": "UseSlotValuesAsCustomVocabulary" + "type": "enum", + "members": { + "UseSlotValuesAsCustomVocabulary": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UseSlotValuesAsCustomVocabulary" + } + } + } + }, + "com.amazonaws.lexmodelsv2#AudioSpecification": { + "type": "structure", + "members": { + "maxLengthMs": { + "target": "com.amazonaws.lexmodelsv2#TimeInMilliSeconds", + "traits": { + "smithy.api#documentation": "Time for how long Amazon Lex waits before speech input is truncated and the speech \n is returned to application.
", + "smithy.api#required": {} + } + }, + "endTimeoutMs": { + "target": "com.amazonaws.lexmodelsv2#TimeInMilliSeconds", + "traits": { + "smithy.api#documentation": "Time for which a bot waits after the customer stops speaking to assume the \n utterance is finished.
", + "smithy.api#required": {} } - ] + } + }, + "traits": { + "smithy.api#documentation": "Specifies the audio input specifications.
" } }, "com.amazonaws.lexmodelsv2#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.lexmodelsv2#BotAliasHistoryEvent": { "type": "structure", @@ -403,6 +484,7 @@ "enabled": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether the locale is enabled for the bot. If the value\n is false, the locale isn't available for use.
The identifier of the bot that contains the custom vocabulary to export.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the bot that contains the custom vocabulary to export.
", + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the custom vocabulary to export.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The locale of the bot that contains the custom vocabulary to export.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the parameters required for exporting a custom vocabulary.
" + } + }, + "com.amazonaws.lexmodelsv2#CustomVocabularyImportSpecification": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot to import the custom vocabulary to.
", + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot to import the custom vocabulary to.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the local to import the custom vocabulary to. The value must\n be en_GB.
Provides the parameters required for importing a custom vocabulary.
" + } + }, + "com.amazonaws.lexmodelsv2#CustomVocabularyStatus": { + "type": "enum", + "members": { + "Ready": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ready" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Exporting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exporting" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "Importing": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the bot that contains the custom vocabulary to export.
", - "smithy.api#required": {} + "smithy.api#enumValue": "Importing" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "Creating": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The locale of the bot that contains the custom vocabulary to export.
", - "smithy.api#required": {} + "smithy.api#enumValue": "Creating" } } - }, + } + }, + "com.amazonaws.lexmodelsv2#DTMFCharacter": { + "type": "string", "traits": { - "smithy.api#documentation": "Provides the parameters required for exporting a custom vocabulary.
" + "smithy.api#pattern": "^[A-D0-9#*]{1}$" } }, - "com.amazonaws.lexmodelsv2#CustomVocabularyImportSpecification": { + "com.amazonaws.lexmodelsv2#DTMFSpecification": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "maxLength": { + "target": "com.amazonaws.lexmodelsv2#MaxUtteranceDigits", "traits": { - "smithy.api#documentation": "The identifier of the bot to import the custom vocabulary to.
", + "smithy.api#documentation": "The maximum number of DTMF digits allowed in an utterance.
", "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "endTimeoutMs": { + "target": "com.amazonaws.lexmodelsv2#TimeInMilliSeconds", "traits": { - "smithy.api#documentation": "The version of the bot to import the custom vocabulary to.
", + "smithy.api#documentation": "How long the bot should wait after the last DTMF character input before assuming \n that the input has concluded.
", "smithy.api#required": {} } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "deletionCharacter": { + "target": "com.amazonaws.lexmodelsv2#DTMFCharacter", "traits": { - "smithy.api#documentation": "The identifier of the local to import the custom vocabulary to. The value must\n be en_GB.
The DTMF character that clears the accumulated DTMF digits and immediately ends \n the input.
", + "smithy.api#required": {} + } + }, + "endCharacter": { + "target": "com.amazonaws.lexmodelsv2#DTMFCharacter", + "traits": { + "smithy.api#documentation": "The DTMF character that immediately ends input. If the user does not press this \n character, the input ends after the end timeout.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides the parameters required for importing a custom vocabulary.
" - } - }, - "com.amazonaws.lexmodelsv2#CustomVocabularyStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ready", - "name": "Ready" - }, - { - "value": "Deleting", - "name": "Deleting" - }, - { - "value": "Exporting", - "name": "Exporting" - }, - { - "value": "Importing", - "name": "Importing" - }, - { - "value": "Creating", - "name": "Creating" - } - ] + "smithy.api#documentation": "Specifies the DTMF input specifications.
" } }, "com.amazonaws.lexmodelsv2#DataPrivacy": { @@ -3534,6 +3713,7 @@ "childDirected": { "target": "com.amazonaws.lexmodelsv2#ChildDirected", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "For each Amazon Lex bot created with the Amazon Lex Model Building Service,\n you must specify whether your use of Amazon Lex is related to a website,\n program, or other application that is directed or targeted, in whole or\n in part, to children under age 13 and subject to the Children's Online\n Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By\n specifying true in the childDirected field,\n you confirm that your use of Amazon Lex is\n related to a website, program, or other application that is directed or\n targeted, in whole or in part, to children under age 13 and subject to\n COPPA. By specifying false in the\n childDirected field, you confirm that your use of Amazon Lex\n is not related to a website,\n program, or other application that is directed or targeted, in whole or\n in part, to children under age 13 and subject to COPPA. You may not\n specify a default value for the childDirected field that\n does not accurately reflect whether your use of Amazon Lex is related to a\n website, program, or other application that is directed or targeted, in\n whole or in part, to children under age 13 and subject to COPPA. If\n your use of Amazon Lex relates to a website, program, or other application\n that is directed in whole or in part, to children under age 13, you\n must obtain any required verifiable parental consent under COPPA. For\n information regarding the use of Amazon Lex in connection with websites,\n programs, or other applications that are directed or targeted, in whole\n or in part, to children under age 13, see the Amazon Lex\n FAQ.
When this parameter is true, Amazon Lex doesn't check to see if any other\n resource is using the alias before it is deleted.
", "smithy.api#httpQuery": "skipResourceInUseCheck" } @@ -3816,6 +3997,7 @@ "skipResourceInUseCheck": { "target": "com.amazonaws.lexmodelsv2#SkipResourceInUseCheck", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When true, Amazon Lex doesn't check to see if another\n resource, such as an alias, is using the bot before it is\n deleted.
By default, the DeleteBotVersion operations throws a\n ResourceInUseException exception if you try to delete a\n bot version that has an alias pointing at it. Set the\n skipResourceInUseCheck parameter to true\n to skip this check and remove the version even if an alias points to\n it.
By default, the DeleteSlotType operations throws a\n ResourceInUseException exception if you try to delete a\n slot type used by a slot. Set the skipResourceInUseCheck\n parameter to true to skip this check and remove the slot\n type even if a slot uses it.
Enables the dialog code hook so that it processes user\n requests.
", "smithy.api#required": {} } @@ -6651,18 +6852,20 @@ } }, "com.amazonaws.lexmodelsv2#Effect": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Allow", - "name": "Allow" - }, - { - "value": "Deny", - "name": "Deny" + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allow" } - ] + }, + "Deny": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deny" + } + } } }, "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting": { @@ -6745,29 +6948,31 @@ } }, "com.amazonaws.lexmodelsv2#ExportFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ExportResourceType", - "name": "ExportResourceType" + "type": "enum", + "members": { + "ExportResourceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportResourceType" } - ] + } } }, "com.amazonaws.lexmodelsv2#ExportFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CO", - "name": "Contains" - }, - { - "value": "EQ", - "name": "Equals" + "type": "enum", + "members": { + "Contains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" } - ] + } } }, "com.amazonaws.lexmodelsv2#ExportFilters": { @@ -6809,14 +7014,14 @@ } }, "com.amazonaws.lexmodelsv2#ExportSortAttribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LastUpdatedDateTime", - "name": "LastUpdatedDateTime" + "type": "enum", + "members": { + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastUpdatedDateTime" } - ] + } } }, "com.amazonaws.lexmodelsv2#ExportSortBy": { @@ -6842,26 +7047,32 @@ } }, "com.amazonaws.lexmodelsv2#ExportStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "InProgress" - }, - { - "value": "Completed", - "name": "Completed" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Deleting", - "name": "Deleting" + "type": "enum", + "members": { + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } } }, "com.amazonaws.lexmodelsv2#ExportSummary": { @@ -6975,6 +7186,7 @@ "enabled": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a Lambda function should be invoked to fulfill a\n specific intent.
", "smithy.api#required": {} } @@ -7005,7 +7217,6 @@ "com.amazonaws.lexmodelsv2#FulfillmentStartResponseDelay": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 900 @@ -7043,7 +7254,6 @@ "com.amazonaws.lexmodelsv2#FulfillmentTimeout": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 900 @@ -7053,7 +7263,6 @@ "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseFrequency": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 900 @@ -7164,10 +7373,7 @@ } }, "com.amazonaws.lexmodelsv2#HitCount": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.lexmodelsv2#Id": { "type": "string", @@ -7213,18 +7419,20 @@ } }, "com.amazonaws.lexmodelsv2#ImportExportFileFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LexJson", - "name": "LexJson" - }, - { - "value": "TSV", - "name": "TSV" + "type": "enum", + "members": { + "LexJson": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LexJson" + } + }, + "TSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TSV" } - ] + } } }, "com.amazonaws.lexmodelsv2#ImportExportFilePassword": { @@ -7267,29 +7475,31 @@ } }, "com.amazonaws.lexmodelsv2#ImportFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ImportResourceType", - "name": "ImportResourceType" + "type": "enum", + "members": { + "ImportResourceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImportResourceType" } - ] + } } }, "com.amazonaws.lexmodelsv2#ImportFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CO", - "name": "Contains" - }, - { - "value": "EQ", - "name": "Equals" + "type": "enum", + "members": { + "Contains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" } - ] + } } }, "com.amazonaws.lexmodelsv2#ImportFilters": { @@ -7328,33 +7538,37 @@ } }, "com.amazonaws.lexmodelsv2#ImportResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Bot", - "name": "Bot" - }, - { - "value": "BotLocale", - "name": "BotLocale" - }, - { - "value": "CustomVocabulary", - "name": "CustomVocabulary" + "type": "enum", + "members": { + "Bot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bot" + } + }, + "BotLocale": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BotLocale" } - ] + }, + "CustomVocabulary": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CustomVocabulary" + } + } } }, "com.amazonaws.lexmodelsv2#ImportSortAttribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LastUpdatedDateTime", - "name": "LastUpdatedDateTime" + "type": "enum", + "members": { + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastUpdatedDateTime" } - ] + } } }, "com.amazonaws.lexmodelsv2#ImportSortBy": { @@ -7380,26 +7594,32 @@ } }, "com.amazonaws.lexmodelsv2#ImportStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "InProgress" - }, - { - "value": "Completed", - "name": "Completed" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Deleting", - "name": "Deleting" + "type": "enum", + "members": { + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } } }, "com.amazonaws.lexmodelsv2#ImportSummary": { @@ -7536,6 +7756,8 @@ "active": { "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": true, "smithy.api#documentation": "Specifies whether an intent's closing response is used. When this\n field is false, the closing response isn't sent to the user. If the\n active field isn't specified, the default is\n true.
Specifies whether the intent's confirmation is sent to the user.\n When this field is false, confirmation and declination responses aren't\n sent. If the active field isn't specified, the default is\n true.
Determines whether the AMAZON.KendraSearchIntent intent uses a\n custom query string to query the Amazon Kendra index.
" } }, @@ -7925,21 +8154,6 @@ }, "com.amazonaws.lexmodelsv2#LexModelBuildingServiceV2": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Lex Models V2", - "arnNamespace": "lex", - "cloudFormationName": "LexModelsV2", - "cloudTrailEventSource": "lexmodelsv2.amazonaws.com", - "endpointPrefix": "models-v2-lex" - }, - "aws.auth#sigv4": { - "name": "lex" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "", - "smithy.api#title": "Amazon Lex Model Building V2" - }, "version": "2020-08-07", "operations": [ { @@ -8143,7 +8357,22 @@ { "target": "com.amazonaws.lexmodelsv2#UpdateSlotType" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Lex Models V2", + "arnNamespace": "lex", + "cloudFormationName": "LexModelsV2", + "cloudTrailEventSource": "lexmodelsv2.amazonaws.com", + "endpointPrefix": "models-v2-lex" + }, + "aws.auth#sigv4": { + "name": "lex" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "", + "smithy.api#title": "Amazon Lex Model Building V2" + } }, "com.amazonaws.lexmodelsv2#LexTranscriptFilter": { "type": "structure", @@ -9799,30 +10028,42 @@ "com.amazonaws.lexmodelsv2#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 } } }, - "com.amazonaws.lexmodelsv2#MergeStrategy": { - "type": "string", + "com.amazonaws.lexmodelsv2#MaxUtteranceDigits": { + "type": "integer", "traits": { - "smithy.api#enum": [ - { - "value": "Overwrite", - "name": "Overwrite" - }, - { - "value": "FailOnConflict", - "name": "FailOnConflict" - }, - { - "value": "Append", - "name": "Append" + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.lexmodelsv2#MergeStrategy": { + "type": "enum", + "members": { + "Overwrite": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Overwrite" + } + }, + "FailOnConflict": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FailOnConflict" + } + }, + "Append": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Append" } - ] + } } }, "com.amazonaws.lexmodelsv2#Message": { @@ -9891,18 +10132,20 @@ } }, "com.amazonaws.lexmodelsv2#MessageSelectionStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Random", - "name": "Random" - }, - { - "value": "Ordered", - "name": "Ordered" + "type": "enum", + "members": { + "Random": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Random" + } + }, + "Ordered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ordered" } - ] + } } }, "com.amazonaws.lexmodelsv2#MessageVariationsList": { @@ -9918,10 +10161,7 @@ } }, "com.amazonaws.lexmodelsv2#MissedCount": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.lexmodelsv2#MultipleValuesSetting": { "type": "structure", @@ -9929,6 +10169,7 @@ "allowMultipleValues": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a slot can return multiple values. When\n true, the slot may return more than one value in a\n response. When false, the slot returns only a single\n value.
Multi-value slots are only available in the en-US locale. If you set\n this value to true in any other locale, Amazon Lex throws a\n ValidationException.
If the allowMutlipleValues is not set, the default\n value is false.
The attempt name of attempts of a prompt.
" + } + }, + "com.amazonaws.lexmodelsv2#PromptAttemptSpecification": { + "type": "structure", + "members": { + "allowInterrupt": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the user can interrupt a speech prompt attempt from the bot.
" + } + }, + "allowedInputTypes": { + "target": "com.amazonaws.lexmodelsv2#AllowedInputTypes", + "traits": { + "smithy.api#documentation": "Indicates the allowed input types of the prompt attempt.
", + "smithy.api#required": {} + } + }, + "audioAndDTMFInputSpecification": { + "target": "com.amazonaws.lexmodelsv2#AudioAndDTMFInputSpecification", + "traits": { + "smithy.api#documentation": "Specifies the settings on audio and DTMF input.
" + } + }, + "textInputSpecification": { + "target": "com.amazonaws.lexmodelsv2#TextInputSpecification", + "traits": { + "smithy.api#documentation": "Specifies the settings on text input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the settings on a prompt attempt.
" + } + }, + "com.amazonaws.lexmodelsv2#PromptAttemptsSpecificationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#PromptAttempt" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#PromptAttemptSpecification" + } + }, "com.amazonaws.lexmodelsv2#PromptMaxRetries": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 5 @@ -10344,6 +10670,12 @@ "traits": { "smithy.api#documentation": "Indicates how a message is selected from a message group among retries.
" } + }, + "promptAttemptsSpecification": { + "target": "com.amazonaws.lexmodelsv2#PromptAttemptsSpecificationMap", + "traits": { + "smithy.api#documentation": "Specifies the advanced settings on each attempt of the prompt.
" + } } }, "traits": { @@ -10422,6 +10754,7 @@ "timeValue": { "target": "com.amazonaws.lexmodelsv2#TimeValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The period of the time window to gather statistics for. The valid\n value depends on the setting of the timeDimension\n field.
\n Hours - 1/3/6/12/24
\n Days - 3
\n Weeks - 1/2
How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
" } }, @@ -10802,18 +11134,20 @@ } }, "com.amazonaws.lexmodelsv2#SearchOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "Ascending" - }, - { - "value": "Descending", - "name": "Descending" + "type": "enum", + "members": { + "Ascending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "Descending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" } - ] + } } }, "com.amazonaws.lexmodelsv2#SentimentAnalysisSettings": { @@ -10822,6 +11156,7 @@ "detectSentiment": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user\n utterances.
", "smithy.api#required": {} } @@ -10867,7 +11202,6 @@ "com.amazonaws.lexmodelsv2#SessionTTL": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 86400 @@ -10875,7 +11209,10 @@ } }, "com.amazonaws.lexmodelsv2#SkipResourceInUseCheck": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.lexmodelsv2#SlotCaptureSetting": { "type": "structure", @@ -10928,18 +11265,20 @@ } }, "com.amazonaws.lexmodelsv2#SlotConstraint": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Required", - "name": "Required" - }, - { - "value": "Optional", - "name": "Optional" + "type": "enum", + "members": { + "Required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Required" + } + }, + "Optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Optional" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotDefaultValue": { @@ -11023,29 +11362,31 @@ } }, "com.amazonaws.lexmodelsv2#SlotFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SlotName", - "name": "SlotName" + "type": "enum", + "members": { + "SlotName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlotName" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CO", - "name": "Contains" - }, - { - "value": "EQ", - "name": "Equals" + "type": "enum", + "members": { + "Contains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" } - ] + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + } } }, "com.amazonaws.lexmodelsv2#SlotFilters": { @@ -11089,33 +11430,37 @@ } }, "com.amazonaws.lexmodelsv2#SlotShape": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Scalar", - "name": "Scalar" - }, - { - "value": "List", - "name": "List" + "type": "enum", + "members": { + "Scalar": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scalar" + } + }, + "List": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "List" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotSortAttribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SlotName", - "name": "SlotName" - }, - { - "value": "LastUpdatedDateTime", - "name": "LastUpdatedDateTime" + "type": "enum", + "members": { + "SlotName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlotName" + } + }, + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastUpdatedDateTime" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotSortBy": { @@ -11197,26 +11542,32 @@ } }, "com.amazonaws.lexmodelsv2#SlotTypeCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Custom", - "name": "Custom" - }, - { - "value": "Extended", - "name": "Extended" - }, - { - "value": "ExternalGrammar", - "name": "ExternalGrammar" - }, - { - "value": "Composite", - "name": "Composite" + "type": "enum", + "members": { + "Custom": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + }, + "Extended": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Extended" + } + }, + "ExternalGrammar": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExternalGrammar" + } + }, + "Composite": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Composite" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotTypeFilter": { @@ -11249,33 +11600,37 @@ } }, "com.amazonaws.lexmodelsv2#SlotTypeFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SlotTypeName", - "name": "SlotTypeName" - }, - { - "value": "ExternalSourceType", - "name": "ExternalSourceType" + "type": "enum", + "members": { + "SlotTypeName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlotTypeName" } - ] + }, + "ExternalSourceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExternalSourceType" + } + } } }, "com.amazonaws.lexmodelsv2#SlotTypeFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CO", - "name": "Contains" - }, - { - "value": "EQ", - "name": "Equals" + "type": "enum", + "members": { + "Contains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotTypeFilters": { @@ -11294,18 +11649,20 @@ "type": "string" }, "com.amazonaws.lexmodelsv2#SlotTypeSortAttribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SlotTypeName", - "name": "SlotTypeName" - }, - { - "value": "LastUpdatedDateTime", - "name": "LastUpdatedDateTime" + "type": "enum", + "members": { + "SlotTypeName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlotTypeName" + } + }, + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastUpdatedDateTime" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotTypeSortBy": { @@ -11533,22 +11890,26 @@ } }, "com.amazonaws.lexmodelsv2#SlotValueResolutionStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OriginalValue", - "name": "OriginalValue" - }, - { - "value": "TopResolution", - "name": "TopResolution" - }, - { - "value": "Concatenation", - "name": "Concatenation" + "type": "enum", + "members": { + "OriginalValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OriginalValue" + } + }, + "TopResolution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TopResolution" + } + }, + "Concatenation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Concatenation" } - ] + } } }, "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting": { @@ -11557,6 +11918,8 @@ "resolutionStrategy": { "target": "com.amazonaws.lexmodelsv2#SlotValueResolutionStrategy", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "OriginalValue", "smithy.api#documentation": "Determines the slot resolution strategy that Amazon Lex uses to\n return slot type values. The field can be set to one of the following\n values:
\n\nOriginalValue - Returns the value entered by the user, if the\n user value is similar to the slot value.
\nTopResolution - If there is a resolution list for the slot,\n return the first value in the resolution list as the slot type\n value. If there is no resolution list, null is returned.
\nIf you don't specify the valueSelectionStrategy, the default is\n OriginalValue.
", "smithy.api#required": {} } @@ -11585,18 +11948,20 @@ } }, "com.amazonaws.lexmodelsv2#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "Ascending" - }, - { - "value": "Descending", - "name": "Descending" + "type": "enum", + "members": { + "Ascending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" } - ] + }, + "Descending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } } }, "com.amazonaws.lexmodelsv2#Specifications": { @@ -11863,7 +12228,6 @@ "com.amazonaws.lexmodelsv2#StillWaitingResponseFrequency": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 300 @@ -11908,7 +12272,6 @@ "com.amazonaws.lexmodelsv2#StillWaitingResponseTimeout": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 900 @@ -12046,7 +12409,7 @@ "min": 0, "max": 640 }, - "smithy.api#pattern": "^[0-9A-Za-z_\\s\\(\\)]+$" + "smithy.api#pattern": "^[0-9A-Za-z_\\-\\s\\(\\)]+$" } }, "com.amazonaws.lexmodelsv2#SubSlotSetting": { @@ -12256,6 +12619,21 @@ } } }, + "com.amazonaws.lexmodelsv2#TextInputSpecification": { + "type": "structure", + "members": { + "startTimeoutMs": { + "target": "com.amazonaws.lexmodelsv2#TimeInMilliSeconds", + "traits": { + "smithy.api#documentation": "Time for which a bot waits before re-prompting a customer for text input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the text input specifications.
" + } + }, "com.amazonaws.lexmodelsv2#TextLogDestination": { "type": "structure", "members": { @@ -12277,6 +12655,7 @@ "enabled": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether conversation logs should be stored for an\n alias.
", "smithy.api#required": {} } @@ -12310,6 +12689,7 @@ "retryAfterSeconds": { "target": "com.amazonaws.lexmodelsv2#RetryAfterSeconds", "traits": { + "smithy.api#default": 0, "smithy.api#httpHeader": "Retry-After" } }, @@ -12324,27 +12704,40 @@ } }, "com.amazonaws.lexmodelsv2#TimeDimension": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Hours", - "name": "Hours" - }, - { - "value": "Days", - "name": "Days" - }, - { - "value": "Weeks", - "name": "Weeks" + "type": "enum", + "members": { + "Hours": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hours" + } + }, + "Days": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Days" + } + }, + "Weeks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Weeks" } - ] + } + } + }, + "com.amazonaws.lexmodelsv2#TimeInMilliSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } } }, "com.amazonaws.lexmodelsv2#TimeValue": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 24 @@ -12379,14 +12772,14 @@ } }, "com.amazonaws.lexmodelsv2#TranscriptFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Lex", - "name": "Lex" + "type": "enum", + "members": { + "Lex": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lex" } - ] + } } }, "com.amazonaws.lexmodelsv2#TranscriptSourceSetting": { @@ -13967,18 +14360,20 @@ } }, "com.amazonaws.lexmodelsv2#VoiceEngine": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "standard", - "name": "Standard" - }, - { - "value": "neural", - "name": "Neural" + "type": "enum", + "members": { + "Standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" } - ] + }, + "Neural": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "neural" + } + } } }, "com.amazonaws.lexmodelsv2#VoiceId": { @@ -13997,6 +14392,8 @@ "engine": { "target": "com.amazonaws.lexmodelsv2#VoiceEngine", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "standard", "smithy.api#documentation": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more\n information, see the \n engine parameter of the\n SynthesizeSpeech operation in the\n Amazon Polly developer guide.
If you do not specify a value, the default is\n standard.
Specifies whether the bot will wait for a user to respond. When this\n field is false, wait and continue responses for a slot aren't used. If\n the active field isn't specified, the default is\n true.
The period, in seconds, over which the statistic is applied.
" } }, @@ -459,22 +470,26 @@ } }, "com.amazonaws.lightsail#AlarmState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OK", - "name": "OK" - }, - { - "value": "ALARM", - "name": "ALARM" - }, - { - "value": "INSUFFICIENT_DATA", - "name": "INSUFFICIENT_DATA" + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" } - ] + }, + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALARM" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_DATA" + } + } } }, "com.amazonaws.lightsail#AlarmsList": { @@ -994,26 +1009,32 @@ } }, "com.amazonaws.lightsail#AutoSnapshotStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Success", - "name": "SUCCESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "NotFound", - "name": "NOT_FOUND" - } - ] + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotFound" + } + } } }, "com.amazonaws.lightsail#AvailabilityZone": { @@ -1043,44 +1064,52 @@ } }, "com.amazonaws.lightsail#BPAStatusMessage": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULTED_FOR_SLR_MISSING", - "name": "DEFAULTED_FOR_SLR_MISSING" - }, - { - "value": "SYNC_ON_HOLD", - "name": "SYNC_ON_HOLD" - }, - { - "value": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD", - "name": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" - }, - { - "value": "Unknown", - "name": "Unknown" - } - ] + "type": "enum", + "members": { + "DEFAULTED_FOR_SLR_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING" + } + }, + "SYNC_ON_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC_ON_HOLD" + } + }, + "DEFAULTED_FOR_SLR_MISSING_ON_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } } }, "com.amazonaws.lightsail#Base64": { "type": "string" }, "com.amazonaws.lightsail#BehaviorEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "dont-cache", - "name": "DontCacheSetting" - }, - { - "value": "cache", - "name": "CacheSetting" + "type": "enum", + "members": { + "DontCacheSetting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dont-cache" + } + }, + "CacheSetting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache" } - ] + } } }, "com.amazonaws.lightsail#Blueprint": { @@ -1170,18 +1199,20 @@ } }, "com.amazonaws.lightsail#BlueprintType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "os", - "name": "os" - }, - { - "value": "app", - "name": "app" + "type": "enum", + "members": { + "os": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "os" + } + }, + "app": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "app" } - ] + } } }, "com.amazonaws.lightsail#Bucket": { @@ -1382,18 +1413,20 @@ } }, "com.amazonaws.lightsail#BucketMetricName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BucketSizeBytes", - "name": "BucketSizeBytes" - }, - { - "value": "NumberOfObjects", - "name": "NumberOfObjects" + "type": "enum", + "members": { + "BucketSizeBytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketSizeBytes" + } + }, + "NumberOfObjects": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NumberOfObjects" } - ] + } } }, "com.amazonaws.lightsail#BucketName": { @@ -1656,6 +1689,7 @@ "inUseResourceCount": { "target": "com.amazonaws.lightsail#InUseResourceCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of Lightsail resources that the certificate is attached to.
" } }, @@ -1740,38 +1774,50 @@ "type": "string" }, "com.amazonaws.lightsail#CertificateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_VALIDATION", - "name": "PendingValidation" - }, - { - "value": "ISSUED", - "name": "Issued" - }, - { - "value": "INACTIVE", - "name": "Inactive" - }, - { - "value": "EXPIRED", - "name": "Expired" - }, - { - "value": "VALIDATION_TIMED_OUT", - "name": "ValidationTimedOut" - }, - { - "value": "REVOKED", - "name": "Revoked" - }, - { - "value": "FAILED", - "name": "Failed" - } - ] + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lightsail#CertificateStatusList": { @@ -1989,37 +2035,43 @@ } }, "com.amazonaws.lightsail#CloudFormationStackRecordSourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ExportSnapshotRecord", - "name": "ExportSnapshotRecord" + "type": "enum", + "members": { + "ExportSnapshotRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportSnapshotRecord" } - ] + } } }, "com.amazonaws.lightsail#ComparisonOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GreaterThanOrEqualToThreshold", - "name": "GreaterThanOrEqualToThreshold" - }, - { - "value": "GreaterThanThreshold", - "name": "GreaterThanThreshold" - }, - { - "value": "LessThanThreshold", - "name": "LessThanThreshold" - }, - { - "value": "LessThanOrEqualToThreshold", - "name": "LessThanOrEqualToThreshold" - } - ] + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } } }, "com.amazonaws.lightsail#ContactMethod": { @@ -2085,33 +2137,37 @@ } }, "com.amazonaws.lightsail#ContactMethodStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PendingVerification", - "name": "PendingVerification" - }, - { - "value": "Valid", - "name": "Valid" - }, - { - "value": "Invalid", - "name": "Invalid" + "type": "enum", + "members": { + "PendingVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingVerification" + } + }, + "Valid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Valid" } - ] + }, + "Invalid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Invalid" + } + } } }, "com.amazonaws.lightsail#ContactMethodVerificationProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Email", - "name": "Email" + "type": "enum", + "members": { + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" } - ] + } } }, "com.amazonaws.lightsail#ContactMethodsList": { @@ -2121,18 +2177,20 @@ } }, "com.amazonaws.lightsail#ContactProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Email", - "name": "Email" - }, - { - "value": "SMS", - "name": "SMS" + "type": "enum", + "members": { + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" + } + }, + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" } - ] + } } }, "com.amazonaws.lightsail#ContactProtocolsList": { @@ -2421,26 +2479,32 @@ } }, "com.amazonaws.lightsail#ContainerServiceDeploymentState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVATING", - "name": "ACTIVATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { @@ -2509,30 +2573,40 @@ "healthyThreshold": { "target": "com.amazonaws.lightsail#integer", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 2, "smithy.api#documentation": "The number of consecutive health checks successes required before moving the container to\n the Healthy state. The default value is 2.
The number of consecutive health check failures required before moving the container to\n the Unhealthy state. The default value is 2.
The amount of time, in seconds, during which no response means a failed health check. You\n can specify between 2 and 60 seconds. The default value is 2.
The approximate interval, in seconds, between health checks of an individual container.\n You can specify between 5 and 300 seconds. The default value is 5.
The path on the container on which to perform the health check. The default value is\n /.
The IP address type for the distribution.
\n\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The IP address type for the instance.
\n\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The IP address type for the instance.
\n\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The instance port where you're creating your load balancer.
", "smithy.api#required": {} } @@ -4615,6 +4741,8 @@ "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "dualstack", "smithy.api#documentation": "The IP address type for the load balancer.
\n\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The granularity, in seconds, of the returned data points.
\nBucket storage metrics are reported once per day. Therefore, you should specify a period\n of 86400 seconds, which is the number of seconds in a day.
\nIndicates whether to include detailed information about the certificates in the\n response.
\nWhen omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.
" } }, @@ -8898,6 +9058,7 @@ "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The granularity, in seconds, of the returned data points.
\n\nAll container service metric data is available in 5-minute (300 seconds)\n granularity.
", "smithy.api#httpQuery": "period", "smithy.api#required": {} @@ -9475,6 +9636,7 @@ "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The granularity, in seconds, for the metric data points that will be returned.
", "smithy.api#required": {} } @@ -9944,13 +10106,14 @@ "metricName": { "target": "com.amazonaws.lightsail#InstanceMetricName", "traits": { - "smithy.api#documentation": "The metric for which you want to return information.
\nValid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.
\n \n BurstCapacityPercentage\n - The percentage\n of CPU performance available for your instance to burst above its baseline. Your instance\n continuously accrues and consumes burst capacity. Burst capacity stops accruing when your\n instance's BurstCapacityPercentage reaches 100%. For more information, see\n Viewing instance burst capacity in Amazon Lightsail.
\n Statistics: The most useful statistics are Maximum and\n Average.
\n Unit: The published unit is Percent.
\n \n BurstCapacityTime\n - The available amount\n of time for your instance to burst at 100% CPU utilization. Your instance continuously\n accrues and consumes burst capacity. Burst capacity time stops accruing when your\n instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at\n 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the\n burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50%\n rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity\n minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
\n\n Statistics: The most useful statistics are Maximum and\n Average.
\n Unit: The published unit is Seconds.
\n \n CPUUtilization\n - The percentage of\n allocated compute units that are currently in use on the instance. This metric identifies\n the processing power to run the applications on the instance. Tools in your operating\n system can show a lower percentage than Lightsail when the instance is not allocated a\n full processor core.
\n Statistics: The most useful statistics are Maximum and\n Average.
\n Unit: The published unit is Percent.
\n \n NetworkIn\n - The number of bytes received\n on all network interfaces by the instance. This metric identifies the volume of incoming\n network traffic to the instance. The number reported is the number of bytes received\n during the period. Because this metric is reported in 5-minute intervals, divide the\n reported number by 300 to find Bytes/second.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Bytes.
\n \n NetworkOut\n - The number of bytes sent\n out on all network interfaces by the instance. This metric identifies the volume of\n outgoing network traffic from the instance. The number reported is the number of bytes\n sent during the period. Because this metric is reported in 5-minute intervals, divide the\n reported number by 300 to find Bytes/second.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Bytes.
\n \n StatusCheckFailed\n - Reports whether the\n instance passed or failed both the instance status check and the system status check. This\n metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute\n (60 seconds) granularity.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
\n \n StatusCheckFailed_Instance\n - Reports\n whether the instance passed or failed the instance status check. This metric can be either\n 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)\n granularity.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
\n \n StatusCheckFailed_System\n - Reports\n whether the instance passed or failed the system status check. This metric can be either 0\n (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)\n granularity.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
The metric for which you want to return information.
\nValid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.
\n \n BurstCapacityPercentage\n - The percentage\n of CPU performance available for your instance to burst above its baseline. Your instance\n continuously accrues and consumes burst capacity. Burst capacity stops accruing when your\n instance's BurstCapacityPercentage reaches 100%. For more information, see\n Viewing instance burst capacity in Amazon Lightsail.
\n Statistics: The most useful statistics are Maximum and\n Average.
\n Unit: The published unit is Percent.
\n \n BurstCapacityTime\n - The available amount\n of time for your instance to burst at 100% CPU utilization. Your instance continuously\n accrues and consumes burst capacity. Burst capacity time stops accruing when your\n instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at\n 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the\n burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50%\n rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity\n minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
\n\n Statistics: The most useful statistics are Maximum and\n Average.
\n Unit: The published unit is Seconds.
\n \n CPUUtilization\n - The percentage of\n allocated compute units that are currently in use on the instance. This metric identifies\n the processing power to run the applications on the instance. Tools in your operating\n system can show a lower percentage than Lightsail when the instance is not allocated a\n full processor core.
\n Statistics: The most useful statistics are Maximum and\n Average.
\n Unit: The published unit is Percent.
\n \n NetworkIn\n - The number of bytes received\n on all network interfaces by the instance. This metric identifies the volume of incoming\n network traffic to the instance. The number reported is the number of bytes received\n during the period. Because this metric is reported in 5-minute intervals, divide the\n reported number by 300 to find Bytes/second.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Bytes.
\n \n NetworkOut\n - The number of bytes sent\n out on all network interfaces by the instance. This metric identifies the volume of\n outgoing network traffic from the instance. The number reported is the number of bytes\n sent during the period. Because this metric is reported in 5-minute intervals, divide the\n reported number by 300 to find Bytes/second.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Bytes.
\n \n StatusCheckFailed\n - Reports whether the\n instance passed or failed both the instance status check and the system status check. This\n metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute\n (60 seconds) granularity.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
\n \n StatusCheckFailed_Instance\n - Reports\n whether the instance passed or failed the instance status check. This metric can be either\n 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)\n granularity.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
\n \n StatusCheckFailed_System\n - Reports\n whether the instance passed or failed the system status check. This metric can be either 0\n (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)\n granularity.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
\n \n MetadataNoToken\n - Reports the number of\n times that the instance metadata service was successfully accessed without a token. This\n metric determines if there are any processes accessing instance metadata by using Instance\n Metadata Service Version 1, which doesn't use a token. If all requests use token-backed\n sessions, such as Instance Metadata Service Version 2, then the value is 0.
\n Statistics: The most useful statistic is Sum.
\n Unit: The published unit is Count.
The granularity, in seconds, of the returned data points.
\nThe StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.
The granularity, in seconds, of the returned data points.
", "smithy.api#required": {} } @@ -11702,6 +11866,7 @@ "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The granularity, in seconds, of the returned data points.
\nAll relational database metric data is available in 1-minute (60 seconds)\n granularity.
", "smithy.api#required": {} } @@ -12182,70 +12347,98 @@ } }, "com.amazonaws.lightsail#HeaderEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Accept", - "name": "accept" - }, - { - "value": "Accept-Charset", - "name": "acceptCharset" - }, - { - "value": "Accept-Datetime", - "name": "acceptDatetime" - }, - { - "value": "Accept-Encoding", - "name": "acceptEncoding" - }, - { - "value": "Accept-Language", - "name": "acceptLanguage" - }, - { - "value": "Authorization", - "name": "authorization" - }, - { - "value": "CloudFront-Forwarded-Proto", - "name": "cloudFrontForwardedProto" - }, - { - "value": "CloudFront-Is-Desktop-Viewer", - "name": "cloudFrontIsDesktopViewer" - }, - { - "value": "CloudFront-Is-Mobile-Viewer", - "name": "cloudFrontIsMobileViewer" - }, - { - "value": "CloudFront-Is-SmartTV-Viewer", - "name": "cloudFrontIsSmartTVViewer" - }, - { - "value": "CloudFront-Is-Tablet-Viewer", - "name": "cloudFrontIsTabletViewer" - }, - { - "value": "CloudFront-Viewer-Country", - "name": "cloudFrontViewerCountry" - }, - { - "value": "Host", - "name": "host" - }, - { - "value": "Origin", - "name": "origin" - }, - { - "value": "Referer", - "name": "referer" - } - ] + "type": "enum", + "members": { + "accept": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept" + } + }, + "acceptCharset": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Charset" + } + }, + "acceptDatetime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Datetime" + } + }, + "acceptEncoding": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Encoding" + } + }, + "acceptLanguage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Language" + } + }, + "authorization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Authorization" + } + }, + "cloudFrontForwardedProto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Forwarded-Proto" + } + }, + "cloudFrontIsDesktopViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Desktop-Viewer" + } + }, + "cloudFrontIsMobileViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Mobile-Viewer" + } + }, + "cloudFrontIsSmartTVViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-SmartTV-Viewer" + } + }, + "cloudFrontIsTabletViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Tablet-Viewer" + } + }, + "cloudFrontViewerCountry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Viewer-Country" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Host" + } + }, + "origin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Origin" + } + }, + "referer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Referer" + } + } } }, "com.amazonaws.lightsail#HeaderForwardList": { @@ -12330,6 +12523,57 @@ "target": "com.amazonaws.lightsail#HostKeyAttributes" } }, + "com.amazonaws.lightsail#HttpEndpoint": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.lightsail#HttpProtocolIpv6": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.lightsail#HttpTokens": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, "com.amazonaws.lightsail#IAMAccessKeyId": { "type": "string", "traits": { @@ -12412,10 +12656,16 @@ } }, "com.amazonaws.lightsail#InUseResourceCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.lightsail#IncludeCertificateDetails": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.lightsail#InputOrigin": { "type": "structure", @@ -12571,6 +12821,12 @@ "traits": { "smithy.api#documentation": "The name of the SSH key being used to connect to the instance (e.g.,\n LightsailDefaultKeyPair).
The metadata options for the Amazon Lightsail instance.
" + } } }, "traits": { @@ -12646,18 +12902,20 @@ } }, "com.amazonaws.lightsail#InstanceAccessProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ssh", - "name": "ssh" - }, - { - "value": "rdp", - "name": "rdp" + "type": "enum", + "members": { + "ssh": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssh" } - ] + }, + "rdp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rdp" + } + } } }, "com.amazonaws.lightsail#InstanceEntry": { @@ -12735,197 +12993,304 @@ } }, "com.amazonaws.lightsail#InstanceHealthReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Lb.RegistrationInProgress", - "name": "LbRegistrationInProgress" - }, - { - "value": "Lb.InitialHealthChecking", - "name": "LbInitialHealthChecking" - }, - { - "value": "Lb.InternalError", - "name": "LbInternalError" - }, - { - "value": "Instance.ResponseCodeMismatch", - "name": "InstanceResponseCodeMismatch" - }, - { - "value": "Instance.Timeout", - "name": "InstanceTimeout" - }, - { - "value": "Instance.FailedHealthChecks", - "name": "InstanceFailedHealthChecks" - }, - { - "value": "Instance.NotRegistered", - "name": "InstanceNotRegistered" - }, - { - "value": "Instance.NotInUse", - "name": "InstanceNotInUse" - }, - { - "value": "Instance.DeregistrationInProgress", - "name": "InstanceDeregistrationInProgress" - }, - { - "value": "Instance.InvalidState", - "name": "InstanceInvalidState" - }, - { - "value": "Instance.IpUnusable", - "name": "InstanceIpUnusable" - } - ] - } - }, - "com.amazonaws.lightsail#InstanceHealthState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "initial", - "name": "Initial" - }, - { - "value": "healthy", - "name": "Healthy" - }, - { - "value": "unhealthy", - "name": "Unhealthy" - }, - { - "value": "unused", - "name": "Unused" - }, - { - "value": "draining", - "name": "Draining" - }, - { - "value": "unavailable", - "name": "Unavailable" - } - ] - } - }, - "com.amazonaws.lightsail#InstanceHealthSummary": { - "type": "structure", + "type": "enum", "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "LbRegistrationInProgress": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the Lightsail instance for which you are requesting health check\n data.
" + "smithy.api#enumValue": "Lb.RegistrationInProgress" } }, - "instanceHealth": { - "target": "com.amazonaws.lightsail#InstanceHealthState", + "LbInitialHealthChecking": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Describes the overall instance health. Valid values are below.
" + "smithy.api#enumValue": "Lb.InitialHealthChecking" } }, - "instanceHealthReason": { - "target": "com.amazonaws.lightsail#InstanceHealthReason", + "LbInternalError": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.
If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Lb.RegistrationInProgress\n - The target\n instance is in the process of being registered with the load balancer.
\n \n Lb.InitialHealthChecking\n - The\n Lightsail load balancer is still sending the target instance the minimum number of\n health checks required to determine its health status.
If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Instance.ResponseCodeMismatch\n - The\n health checks did not return an expected HTTP code.
\n \n Instance.Timeout\n - The health check\n requests timed out.
\n \n Instance.FailedHealthChecks\n - The health\n checks failed because the connection to the target instance timed out, the target instance\n response was malformed, or the target instance failed the health check for an unknown\n reason.
\n \n Lb.InternalError\n - The health checks\n failed due to an internal error.
If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Instance.NotRegistered\n - The target\n instance is not registered with the target group.
\n \n Instance.NotInUse\n - The target group is\n not used by any load balancer, or the target instance is in an Availability Zone that is\n not enabled for its load balancer.
\n \n Instance.IpUnusable\n - The target IP\n address is reserved for use by a Lightsail load balancer.
\n \n Instance.InvalidState\n - The target is in\n the stopped or terminated state.
If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Instance.DeregistrationInProgress\n - The\n target instance is in the process of being deregistered and the deregistration delay\n period has not expired.
Describes information about the health of the instance.
" - } - }, - "com.amazonaws.lightsail#InstanceHealthSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceHealthSummary" - } - }, - "com.amazonaws.lightsail#InstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Instance" - } - }, - "com.amazonaws.lightsail#InstanceMetricName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CPUUtilization", - "name": "CPUUtilization" - }, - { - "value": "NetworkIn", - "name": "NetworkIn" - }, - { - "value": "NetworkOut", - "name": "NetworkOut" - }, - { - "value": "StatusCheckFailed", - "name": "StatusCheckFailed" - }, - { - "value": "StatusCheckFailed_Instance", - "name": "StatusCheckFailed_Instance" - }, - { - "value": "StatusCheckFailed_System", - "name": "StatusCheckFailed_System" - }, - { - "value": "BurstCapacityTime", - "name": "BurstCapacityTime" - }, - { - "value": "BurstCapacityPercentage", - "name": "BurstCapacityPercentage" - } - ] - } - }, - "com.amazonaws.lightsail#InstanceNetworking": { - "type": "structure", - "members": { - "monthlyTransfer": { - "target": "com.amazonaws.lightsail#MonthlyTransfer", + }, + "InstanceResponseCodeMismatch": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The amount of data in GB allocated for monthly data transfers.
" + "smithy.api#enumValue": "Instance.ResponseCodeMismatch" } }, - "ports": { - "target": "com.amazonaws.lightsail#InstancePortInfoList", + "InstanceTimeout": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An array of key-value pairs containing information about the ports on the instance.
" + "smithy.api#enumValue": "Instance.Timeout" } - } - }, - "traits": { + }, + "InstanceFailedHealthChecks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.FailedHealthChecks" + } + }, + "InstanceNotRegistered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.NotRegistered" + } + }, + "InstanceNotInUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.NotInUse" + } + }, + "InstanceDeregistrationInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.DeregistrationInProgress" + } + }, + "InstanceInvalidState": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.InvalidState" + } + }, + "InstanceIpUnusable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.IpUnusable" + } + } + } + }, + "com.amazonaws.lightsail#InstanceHealthState": { + "type": "enum", + "members": { + "Initial": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initial" + } + }, + "Healthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthy" + } + }, + "Unhealthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unhealthy" + } + }, + "Unused": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unused" + } + }, + "Draining": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "draining" + } + }, + "Unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.lightsail#InstanceHealthSummary": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Lightsail instance for which you are requesting health check\n data.
" + } + }, + "instanceHealth": { + "target": "com.amazonaws.lightsail#InstanceHealthState", + "traits": { + "smithy.api#documentation": "Describes the overall instance health. Valid values are below.
" + } + }, + "instanceHealthReason": { + "target": "com.amazonaws.lightsail#InstanceHealthReason", + "traits": { + "smithy.api#documentation": "More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.
If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Lb.RegistrationInProgress\n - The target\n instance is in the process of being registered with the load balancer.
\n \n Lb.InitialHealthChecking\n - The\n Lightsail load balancer is still sending the target instance the minimum number of\n health checks required to determine its health status.
If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Instance.ResponseCodeMismatch\n - The\n health checks did not return an expected HTTP code.
\n \n Instance.Timeout\n - The health check\n requests timed out.
\n \n Instance.FailedHealthChecks\n - The health\n checks failed because the connection to the target instance timed out, the target instance\n response was malformed, or the target instance failed the health check for an unknown\n reason.
\n \n Lb.InternalError\n - The health checks\n failed due to an internal error.
If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Instance.NotRegistered\n - The target\n instance is not registered with the target group.
\n \n Instance.NotInUse\n - The target group is\n not used by any load balancer, or the target instance is in an Availability Zone that is\n not enabled for its load balancer.
\n \n Instance.IpUnusable\n - The target IP\n address is reserved for use by a Lightsail load balancer.
\n \n Instance.InvalidState\n - The target is in\n the stopped or terminated state.
If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:
\n \n Instance.DeregistrationInProgress\n - The\n target instance is in the process of being deregistered and the deregistration delay\n period has not expired.
Describes information about the health of the instance.
" + } + }, + "com.amazonaws.lightsail#InstanceHealthSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceHealthSummary" + } + }, + "com.amazonaws.lightsail#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Instance" + } + }, + "com.amazonaws.lightsail#InstanceMetadataOptions": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.lightsail#InstanceMetadataState", + "traits": { + "smithy.api#documentation": "The state of the metadata option changes.
\nThe following states are possible:
\n\n pending - The metadata options are being updated. The instance is not yet\n ready to process metadata traffic with the new selection.
\n applied - The metadata options have been successfully applied to the\n instance.
The state of token usage for your instance metadata requests.
\n\nIf the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.
If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.
Not all instance blueprints in Lightsail support version 2.0 credentials.\n Use the MetadataNoToken instance metric to track the number of calls to the\n instance metadata service that are using version 1.0 credentials. For more information, see\n Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.
\n\nIf the value is disabled, you cannot access your instance metadata.
The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther.
" + } + }, + "httpProtocolIpv6": { + "target": "com.amazonaws.lightsail#HttpProtocolIpv6", + "traits": { + "smithy.api#documentation": "Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata options for the instance.
" + } + }, + "com.amazonaws.lightsail#InstanceMetadataState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.lightsail#InstanceMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "NetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkIn" + } + }, + "NetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkOut" + } + }, + "StatusCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed" + } + }, + "StatusCheckFailed_Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_Instance" + } + }, + "StatusCheckFailed_System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_System" + } + }, + "BurstCapacityTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityTime" + } + }, + "BurstCapacityPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityPercentage" + } + }, + "MetadataNoToken": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MetadataNoToken" + } + } + } + }, + "com.amazonaws.lightsail#InstanceNetworking": { + "type": "structure", + "members": { + "monthlyTransfer": { + "target": "com.amazonaws.lightsail#MonthlyTransfer", + "traits": { + "smithy.api#documentation": "The amount of data in GB allocated for monthly data transfers.
" + } + }, + "ports": { + "target": "com.amazonaws.lightsail#InstancePortInfoList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs containing information about the ports on the instance.
" + } + } + }, + "traits": { "smithy.api#documentation": "Describes monthly data transfer rates and port information for an instance.
" } }, "com.amazonaws.lightsail#InstancePlatform": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LINUX_UNIX", - "name": "LinuxUnix" - }, - { - "value": "WINDOWS", - "name": "Windows" + "type": "enum", + "members": { + "LinuxUnix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX_UNIX" + } + }, + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" } - ] + } } }, "com.amazonaws.lightsail#InstancePlatformList": { @@ -12940,12 +13305,14 @@ "fromPort": { "target": "com.amazonaws.lightsail#Port", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The first port in a range of open ports on an instance.
\nAllowed ports:
\nTCP and UDP - 0 to 65535\n
ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the\n fromPort (ICMP type), and -1 as the toPort (ICMP\n code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as\n the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6\n code). For more information, see Internet\n Control Message Protocol for IPv6.
The last port in a range of open ports on an instance.
\nAllowed ports:
\nTCP and UDP - 0 to 65535\n
ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the\n fromPort (ICMP type), and -1 as the toPort (ICMP\n code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as\n the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6\n code). For more information, see Internet\n Control Message Protocol for IPv6.
The first port in a range of open ports on an instance.
\nAllowed ports:
\nTCP and UDP - 0 to 65535\n
ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the\n fromPort (ICMP type), and -1 as the toPort (ICMP\n code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as\n the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6\n code). For more information, see Internet\n Control Message Protocol for IPv6.
The last port in a range of open ports on an instance.
\nAllowed ports:
\nTCP and UDP - 0 to 65535\n
ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the\n fromPort (ICMP type), and -1 as the toPort (ICMP\n code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as\n the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6\n code). For more information, see Internet\n Control Message Protocol for IPv6.
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.
\n\nYou can manage your Lightsail resources using the Lightsail console, Lightsail API,\n AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts\n and tasks, see the Amazon Lightsail Developer Guide.
\n\nThis API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.
", - "smithy.api#title": "Amazon Lightsail" - }, "version": "2016-11-28", "operations": [ { @@ -14020,6 +14380,9 @@ { "target": "com.amazonaws.lightsail#UpdateDomainEntry" }, + { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptions" + }, { "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttribute" }, @@ -14029,7 +14392,22 @@ { "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Lightsail", + "arnNamespace": "lightsail", + "cloudFormationName": "Lightsail", + "cloudTrailEventSource": "lightsail.amazonaws.com", + "endpointPrefix": "lightsail" + }, + "aws.auth#sigv4": { + "name": "lightsail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.
\n\nYou can manage your Lightsail resources using the Lightsail console, Lightsail API,\n AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts\n and tasks, see the Amazon Lightsail Developer Guide.
\n\nThis API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.
", + "smithy.api#title": "Amazon Lightsail" + } }, "com.amazonaws.lightsail#LoadBalancer": { "type": "structure", @@ -14154,30 +14532,38 @@ } }, "com.amazonaws.lightsail#LoadBalancerAttributeName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HealthCheckPath", - "name": "HealthCheckPath" - }, - { - "value": "SessionStickinessEnabled", - "name": "SessionStickinessEnabled" - }, - { - "value": "SessionStickiness_LB_CookieDurationSeconds", - "name": "SessionStickiness_LB_CookieDurationSeconds" - }, - { - "value": "HttpsRedirectionEnabled", - "name": "HttpsRedirectionEnabled" - }, - { - "value": "TlsPolicyName", - "name": "TlsPolicyName" - } - ] + "type": "enum", + "members": { + "HealthCheckPath": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthCheckPath" + } + }, + "SessionStickinessEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStickinessEnabled" + } + }, + "SessionStickiness_LB_CookieDurationSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStickiness_LB_CookieDurationSeconds" + } + }, + "HttpsRedirectionEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HttpsRedirectionEnabled" + } + }, + "TlsPolicyName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TlsPolicyName" + } + } } }, "com.amazonaws.lightsail#LoadBalancerConfigurationOptions": { @@ -14196,104 +14582,136 @@ } }, "com.amazonaws.lightsail#LoadBalancerMetricName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ClientTLSNegotiationErrorCount", - "name": "ClientTLSNegotiationErrorCount" - }, - { - "value": "HealthyHostCount", - "name": "HealthyHostCount" - }, - { - "value": "UnhealthyHostCount", - "name": "UnhealthyHostCount" - }, - { - "value": "HTTPCode_LB_4XX_Count", - "name": "HTTPCode_LB_4XX_Count" - }, - { - "value": "HTTPCode_LB_5XX_Count", - "name": "HTTPCode_LB_5XX_Count" - }, - { - "value": "HTTPCode_Instance_2XX_Count", - "name": "HTTPCode_Instance_2XX_Count" - }, - { - "value": "HTTPCode_Instance_3XX_Count", - "name": "HTTPCode_Instance_3XX_Count" - }, - { - "value": "HTTPCode_Instance_4XX_Count", - "name": "HTTPCode_Instance_4XX_Count" - }, - { - "value": "HTTPCode_Instance_5XX_Count", - "name": "HTTPCode_Instance_5XX_Count" - }, - { - "value": "InstanceResponseTime", - "name": "InstanceResponseTime" - }, - { - "value": "RejectedConnectionCount", - "name": "RejectedConnectionCount" - }, - { - "value": "RequestCount", - "name": "RequestCount" - } - ] - } - }, - "com.amazonaws.lightsail#LoadBalancerProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HTTP_HTTPS", - "name": "HTTP_HTTPS" - }, - { - "value": "HTTP", - "name": "HTTP" - } - ] - } - }, - "com.amazonaws.lightsail#LoadBalancerState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "active", - "name": "Active" - }, - { - "value": "provisioning", - "name": "Provisioning" - }, - { - "value": "active_impaired", - "name": "ActiveImpaired" - }, - { - "value": "failed", - "name": "Failed" - }, - { - "value": "unknown", - "name": "Unknown" - } - ] - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { - "type": "structure", + "type": "enum", + "members": { + "ClientTLSNegotiationErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" + } + }, + "HealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthyHostCount" + } + }, + "UnhealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnhealthyHostCount" + } + }, + "HTTPCode_LB_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" + } + }, + "HTTPCode_LB_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" + } + }, + "HTTPCode_Instance_2XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" + } + }, + "HTTPCode_Instance_3XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" + } + }, + "HTTPCode_Instance_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" + } + }, + "HTTPCode_Instance_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" + } + }, + "InstanceResponseTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceResponseTime" + } + }, + "RejectedConnectionCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectedConnectionCount" + } + }, + "RequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestCount" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerProtocol": { + "type": "enum", + "members": { + "HTTP_HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_HTTPS" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerState": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "Provisioning": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioning" + } + }, + "ActiveImpaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active_impaired" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { + "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", @@ -14451,22 +14869,26 @@ } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_VALIDATION", - "name": "PendingValidation" - }, - { - "value": "FAILED", - "name": "Failed" - }, - { - "value": "SUCCESS", - "name": "Success" + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" } - ] + } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption": { @@ -14540,30 +14962,38 @@ } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NO_AVAILABLE_CONTACTS", - "name": "NoAvailableContacts" - }, - { - "value": "ADDITIONAL_VERIFICATION_REQUIRED", - "name": "AdditionalVerificationRequired" - }, - { - "value": "DOMAIN_NOT_ALLOWED", - "name": "DomainNotAllowed" - }, - { - "value": "INVALID_PUBLIC_DOMAIN", - "name": "InvalidPublicDomain" - }, - { - "value": "OTHER", - "name": "Other" - } - ] + "type": "enum", + "members": { + "NoAvailableContacts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AVAILABLE_CONTACTS" + } + }, + "AdditionalVerificationRequired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDITIONAL_VERIFICATION_REQUIRED" + } + }, + "DomainNotAllowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_NOT_ALLOWED" + } + }, + "InvalidPublicDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PUBLIC_DOMAIN" + } + }, + "Other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateList": { @@ -14573,26 +15003,32 @@ } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_AUTO_RENEWAL", - "name": "PendingAutoRenewal" - }, - { - "value": "PENDING_VALIDATION", - "name": "PendingValidation" - }, - { - "value": "SUCCESS", - "name": "Success" - }, - { - "value": "FAILED", - "name": "Failed" - } - ] + "type": "enum", + "members": { + "PendingAutoRenewal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" + } + }, + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary": { @@ -14616,89 +15052,121 @@ } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNSPECIFIED", - "name": "Unspecified" - }, - { - "value": "KEY_COMPROMISE", - "name": "KeyCompromise" - }, - { - "value": "CA_COMPROMISE", - "name": "CaCompromise" - }, - { - "value": "AFFILIATION_CHANGED", - "name": "AffiliationChanged" - }, - { - "value": "SUPERCEDED", - "name": "Superceded" - }, - { - "value": "CESSATION_OF_OPERATION", - "name": "CessationOfOperation" - }, - { - "value": "CERTIFICATE_HOLD", - "name": "CertificateHold" - }, - { - "value": "REMOVE_FROM_CRL", - "name": "RemoveFromCrl" - }, - { - "value": "PRIVILEGE_WITHDRAWN", - "name": "PrivilegeWithdrawn" - }, - { - "value": "A_A_COMPROMISE", - "name": "AACompromise" - } - ] + "type": "enum", + "members": { + "Unspecified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + }, + "KeyCompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_COMPROMISE" + } + }, + "CaCompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_COMPROMISE" + } + }, + "AffiliationChanged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFFILIATION_CHANGED" + } + }, + "Superceded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERCEDED" + } + }, + "CessationOfOperation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CESSATION_OF_OPERATION" + } + }, + "CertificateHold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_HOLD" + } + }, + "RemoveFromCrl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_FROM_CRL" + } + }, + "PrivilegeWithdrawn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" + } + }, + "AACompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A_A_COMPROMISE" + } + } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_VALIDATION", - "name": "PendingValidation" - }, - { - "value": "ISSUED", - "name": "Issued" - }, - { - "value": "INACTIVE", - "name": "Inactive" - }, - { - "value": "EXPIRED", - "name": "Expired" - }, - { - "value": "VALIDATION_TIMED_OUT", - "name": "ValidationTimedOut" - }, - { - "value": "REVOKED", - "name": "Revoked" - }, - { - "value": "FAILED", - "name": "Failed" - }, - { - "value": "UNKNOWN", - "name": "Unknown" - } - ] + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { @@ -14854,349 +15322,464 @@ } }, "com.amazonaws.lightsail#MetricName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CPUUtilization", - "name": "CPUUtilization" - }, - { - "value": "NetworkIn", - "name": "NetworkIn" - }, - { - "value": "NetworkOut", - "name": "NetworkOut" - }, - { - "value": "StatusCheckFailed", - "name": "StatusCheckFailed" - }, - { - "value": "StatusCheckFailed_Instance", - "name": "StatusCheckFailed_Instance" - }, - { - "value": "StatusCheckFailed_System", - "name": "StatusCheckFailed_System" - }, - { - "value": "ClientTLSNegotiationErrorCount", - "name": "ClientTLSNegotiationErrorCount" - }, - { - "value": "HealthyHostCount", - "name": "HealthyHostCount" - }, - { - "value": "UnhealthyHostCount", - "name": "UnhealthyHostCount" - }, - { - "value": "HTTPCode_LB_4XX_Count", - "name": "HTTPCode_LB_4XX_Count" - }, - { - "value": "HTTPCode_LB_5XX_Count", - "name": "HTTPCode_LB_5XX_Count" - }, - { - "value": "HTTPCode_Instance_2XX_Count", - "name": "HTTPCode_Instance_2XX_Count" - }, - { - "value": "HTTPCode_Instance_3XX_Count", - "name": "HTTPCode_Instance_3XX_Count" - }, - { - "value": "HTTPCode_Instance_4XX_Count", - "name": "HTTPCode_Instance_4XX_Count" - }, - { - "value": "HTTPCode_Instance_5XX_Count", - "name": "HTTPCode_Instance_5XX_Count" - }, - { - "value": "InstanceResponseTime", - "name": "InstanceResponseTime" - }, - { - "value": "RejectedConnectionCount", - "name": "RejectedConnectionCount" - }, - { - "value": "RequestCount", - "name": "RequestCount" - }, - { - "value": "DatabaseConnections", - "name": "DatabaseConnections" - }, - { - "value": "DiskQueueDepth", - "name": "DiskQueueDepth" - }, - { - "value": "FreeStorageSpace", - "name": "FreeStorageSpace" - }, - { - "value": "NetworkReceiveThroughput", - "name": "NetworkReceiveThroughput" - }, - { - "value": "NetworkTransmitThroughput", - "name": "NetworkTransmitThroughput" - }, - { - "value": "BurstCapacityTime", - "name": "BurstCapacityTime" - }, - { - "value": "BurstCapacityPercentage", - "name": "BurstCapacityPercentage" - } - ] - } - }, - "com.amazonaws.lightsail#MetricPeriod": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 86400 - } - } - }, - "com.amazonaws.lightsail#MetricStatistic": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Minimum", - "name": "Minimum" - }, - { - "value": "Maximum", - "name": "Maximum" - }, - { - "value": "Sum", - "name": "Sum" - }, - { - "value": "Average", - "name": "Average" - }, - { - "value": "SampleCount", - "name": "SampleCount" - } - ] - } - }, - "com.amazonaws.lightsail#MetricStatisticList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#MetricStatistic" - } - }, - "com.amazonaws.lightsail#MetricUnit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Seconds", - "name": "Seconds" - }, - { - "value": "Microseconds", - "name": "Microseconds" - }, - { - "value": "Milliseconds", - "name": "Milliseconds" - }, - { - "value": "Bytes", - "name": "Bytes" - }, - { - "value": "Kilobytes", - "name": "Kilobytes" - }, - { - "value": "Megabytes", - "name": "Megabytes" - }, - { - "value": "Gigabytes", - "name": "Gigabytes" - }, - { - "value": "Terabytes", - "name": "Terabytes" - }, - { - "value": "Bits", - "name": "Bits" - }, - { - "value": "Kilobits", - "name": "Kilobits" - }, - { - "value": "Megabits", - "name": "Megabits" - }, - { - "value": "Gigabits", - "name": "Gigabits" - }, - { - "value": "Terabits", - "name": "Terabits" - }, - { - "value": "Percent", - "name": "Percent" - }, - { - "value": "Count", - "name": "Count" - }, - { - "value": "Bytes/Second", - "name": "BytesSecond" - }, - { - "value": "Kilobytes/Second", - "name": "KilobytesSecond" - }, - { - "value": "Megabytes/Second", - "name": "MegabytesSecond" - }, - { - "value": "Gigabytes/Second", - "name": "GigabytesSecond" - }, - { - "value": "Terabytes/Second", - "name": "TerabytesSecond" - }, - { - "value": "Bits/Second", - "name": "BitsSecond" - }, - { - "value": "Kilobits/Second", - "name": "KilobitsSecond" - }, - { - "value": "Megabits/Second", - "name": "MegabitsSecond" - }, - { - "value": "Gigabits/Second", - "name": "GigabitsSecond" - }, - { - "value": "Terabits/Second", - "name": "TerabitsSecond" - }, - { - "value": "Count/Second", - "name": "CountSecond" - }, - { - "value": "None", - "name": "None" - } - ] - } - }, - "com.amazonaws.lightsail#MonitoredResourceInfo": { - "type": "structure", + "type": "enum", "members": { - "arn": { - "target": "com.amazonaws.lightsail#ResourceArn", + "CPUUtilization": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource being monitored.
" + "smithy.api#enumValue": "CPUUtilization" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "NetworkIn": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the Lightsail resource being monitored.
" + "smithy.api#enumValue": "NetworkIn" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "NetworkOut": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Lightsail resource type of the resource being monitored.
\nInstances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.
" + "smithy.api#enumValue": "NetworkOut" } - } - }, - "traits": { - "smithy.api#documentation": "Describes resource being monitored by an alarm.
\nAn alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.
" - } - }, - "com.amazonaws.lightsail#MonthlyTransfer": { - "type": "structure", - "members": { - "gbPerMonthAllocated": { - "target": "com.amazonaws.lightsail#integer", + }, + "StatusCheckFailed": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The amount allocated per month (in GB).
" + "smithy.api#enumValue": "StatusCheckFailed" } - } - }, - "traits": { - "smithy.api#documentation": "Describes the monthly data transfer in and out of your virtual private server (or\n instance).
" - } - }, - "com.amazonaws.lightsail#NetworkProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "tcp", - "name": "TCP" - }, - { - "value": "all", - "name": "ALL" - }, - { - "value": "udp", - "name": "UDP" - }, - { - "value": "icmp", - "name": "ICMP" - } - ] - } - }, - "com.amazonaws.lightsail#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lightsail#NotFoundException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" - }, - "docs": { - "target": "com.amazonaws.lightsail#string" }, - "message": { - "target": "com.amazonaws.lightsail#string" + "StatusCheckFailed_Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_Instance" + } + }, + "StatusCheckFailed_System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_System" + } + }, + "ClientTLSNegotiationErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" + } + }, + "HealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthyHostCount" + } + }, + "UnhealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnhealthyHostCount" + } + }, + "HTTPCode_LB_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" + } + }, + "HTTPCode_LB_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" + } + }, + "HTTPCode_Instance_2XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" + } + }, + "HTTPCode_Instance_3XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" + } + }, + "HTTPCode_Instance_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" + } + }, + "HTTPCode_Instance_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" + } + }, + "InstanceResponseTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceResponseTime" + } + }, + "RejectedConnectionCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectedConnectionCount" + } + }, + "RequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestCount" + } + }, + "DatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DatabaseConnections" + } + }, + "DiskQueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskQueueDepth" + } + }, + "FreeStorageSpace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeStorageSpace" + } + }, + "NetworkReceiveThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkReceiveThroughput" + } + }, + "NetworkTransmitThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkTransmitThroughput" + } + }, + "BurstCapacityTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityTime" + } + }, + "BurstCapacityPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityPercentage" + } + } + } + }, + "com.amazonaws.lightsail#MetricPeriod": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } + }, + "com.amazonaws.lightsail#MetricStatistic": { + "type": "enum", + "members": { + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + } + } + }, + "com.amazonaws.lightsail#MetricStatisticList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#MetricStatistic" + } + }, + "com.amazonaws.lightsail#MetricUnit": { + "type": "enum", + "members": { + "Seconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "Microseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "Milliseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "Bytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "Kilobytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "Megabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "Gigabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "Terabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "Bits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "Kilobits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "Megabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "Gigabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "Terabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "Percent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KilobytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MegabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GigabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TerabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KilobitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MegabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GigabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TerabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "CountSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.lightsail#MonitoredResourceInfo": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource being monitored.
" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Lightsail resource being monitored.
" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "The Lightsail resource type of the resource being monitored.
\nInstances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes resource being monitored by an alarm.
\nAn alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.
" + } + }, + "com.amazonaws.lightsail#MonthlyTransfer": { + "type": "structure", + "members": { + "gbPerMonthAllocated": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "The amount allocated per month (in GB).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the monthly data transfer in and out of your virtual private server (or\n instance).
" + } + }, + "com.amazonaws.lightsail#NetworkProtocol": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + }, + "ICMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icmp" + } + } + } + }, + "com.amazonaws.lightsail#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.lightsail#NotFoundException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" @@ -15232,514 +15815,684 @@ { "target": "com.amazonaws.lightsail#InvalidInputException" }, - { - "target": "com.amazonaws.lightsail#NotFoundException" + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.
\nThe OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.
An object to describe the ports to open for the specified instance.
", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the instance for which to open ports.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.
" + } + } + } + }, + "com.amazonaws.lightsail#Operation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the operation.
" + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "The resource name.
" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type.
" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "The timestamp when the operation was initialized (e.g.,\n 1479816991.349).
The Amazon Web Services Region and Availability Zone.
" + } + }, + "isTerminal": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether the operation is terminal.
" + } + }, + "operationDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "Details about the operation (e.g., Debian-1GB-Ohio-1).
The type of operation.
" + } + }, + "status": { + "target": "com.amazonaws.lightsail#OperationStatus", + "traits": { + "smithy.api#documentation": "The status of the operation.
" + } + }, + "statusChangedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "The timestamp when the status was changed (e.g., 1479816991.349).
The error code.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "The error details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the API operation.
" + } + }, + "com.amazonaws.lightsail#OperationFailureException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "Lightsail throws this exception when an operation fails to execute.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lightsail#OperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Operation" + } + }, + "com.amazonaws.lightsail#OperationStatus": { + "type": "enum", + "members": { + "NotStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } + }, + "com.amazonaws.lightsail#OperationType": { + "type": "enum", + "members": { + "DeleteKnownHostKeys": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteKnownHostKeys" + } + }, + "DeleteInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInstance" + } + }, + "CreateInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstance" + } + }, + "StopInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopInstance" + } + }, + "StartInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartInstance" + } + }, + "RebootInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootInstance" + } + }, + "OpenInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpenInstancePublicPorts" + } + }, + "PutInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutInstancePublicPorts" + } + }, + "CloseInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloseInstancePublicPorts" + } + }, + "AllocateStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllocateStaticIp" + } + }, + "ReleaseStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReleaseStaticIp" + } + }, + "AttachStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachStaticIp" + } + }, + "DetachStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachStaticIp" + } + }, + "UpdateDomainEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDomainEntry" + } + }, + "DeleteDomainEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDomainEntry" + } + }, + "CreateDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDomain" + } + }, + "DeleteDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDomain" + } + }, + "CreateInstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstanceSnapshot" + } + }, + "DeleteInstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInstanceSnapshot" + } + }, + "CreateInstancesFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstancesFromSnapshot" + } + }, + "CreateLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateLoadBalancer" + } + }, + "DeleteLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteLoadBalancer" + } + }, + "AttachInstancesToLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachInstancesToLoadBalancer" + } + }, + "DetachInstancesFromLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachInstancesFromLoadBalancer" + } + }, + "UpdateLoadBalancerAttribute": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateLoadBalancerAttribute" + } + }, + "CreateLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateLoadBalancerTlsCertificate" + } + }, + "DeleteLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteLoadBalancerTlsCertificate" + } + }, + "AttachLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachLoadBalancerTlsCertificate" + } + }, + "CreateDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDisk" + } + }, + "DeleteDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDisk" + } + }, + "AttachDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachDisk" + } + }, + "DetachDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachDisk" + } + }, + "CreateDiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDiskSnapshot" + } + }, + "DeleteDiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDiskSnapshot" + } + }, + "CreateDiskFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDiskFromSnapshot" + } + }, + "CreateRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabase" + } + }, + "UpdateRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRelationalDatabase" + } + }, + "DeleteRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRelationalDatabase" + } + }, + "CreateRelationalDatabaseFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabaseFromSnapshot" + } + }, + "CreateRelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabaseSnapshot" + } + }, + "DeleteRelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRelationalDatabaseSnapshot" + } + }, + "UpdateRelationalDatabaseParameters": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRelationalDatabaseParameters" + } + }, + "StartRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartRelationalDatabase" + } + }, + "RebootRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootRelationalDatabase" + } + }, + "StopRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopRelationalDatabase" + } + }, + "EnableAddOn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EnableAddOn" + } + }, + "DisableAddOn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisableAddOn" + } + }, + "PutAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutAlarm" + } + }, + "GetAlarms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetAlarms" + } + }, + "DeleteAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteAlarm" + } + }, + "TestAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TestAlarm" + } + }, + "CreateContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContactMethod" + } + }, + "GetContactMethods": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetContactMethods" + } + }, + "SendContactMethodVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SendContactMethodVerification" + } + }, + "DeleteContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContactMethod" + } + }, + "CreateDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDistribution" + } + }, + "UpdateDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDistribution" + } + }, + "DeleteDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDistribution" + } + }, + "ResetDistributionCache": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResetDistributionCache" + } + }, + "AttachCertificateToDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachCertificateToDistribution" + } }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" + "DetachCertificateFromDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachCertificateFromDistribution" + } }, - { - "target": "com.amazonaws.lightsail#ServiceException" + "UpdateDistributionBundle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDistributionBundle" + } }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.
\nThe OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.
An object to describe the ports to open for the specified instance.
", - "smithy.api#required": {} + "smithy.api#enumValue": "SetIpAddressType" } }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "CreateCertificate": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the instance for which to open ports.
", - "smithy.api#required": {} + "smithy.api#enumValue": "CreateCertificate" } - } - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", + }, + "DeleteCertificate": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.
" + "smithy.api#enumValue": "DeleteCertificate" } - } - } - }, - "com.amazonaws.lightsail#Operation": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", + }, + "CreateContainerService": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ID of the operation.
" + "smithy.api#enumValue": "CreateContainerService" } }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "UpdateContainerService": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The resource name.
" + "smithy.api#enumValue": "UpdateContainerService" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "DeleteContainerService": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The resource type.
" + "smithy.api#enumValue": "DeleteContainerService" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "CreateContainerServiceDeployment": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The timestamp when the operation was initialized (e.g.,\n 1479816991.349).
The Amazon Web Services Region and Availability Zone.
" + "smithy.api#enumValue": "CreateContainerServiceRegistryLogin" } }, - "isTerminal": { - "target": "com.amazonaws.lightsail#boolean", + "RegisterContainerImage": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A Boolean value indicating whether the operation is terminal.
" + "smithy.api#enumValue": "RegisterContainerImage" } }, - "operationDetails": { - "target": "com.amazonaws.lightsail#string", + "DeleteContainerImage": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Details about the operation (e.g., Debian-1GB-Ohio-1).
The type of operation.
" + "smithy.api#enumValue": "CreateBucket" } }, - "status": { - "target": "com.amazonaws.lightsail#OperationStatus", + "DeleteBucket": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The status of the operation.
" + "smithy.api#enumValue": "DeleteBucket" } }, - "statusChangedAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "CreateBucketAccessKey": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The timestamp when the status was changed (e.g., 1479816991.349).
The error code.
" + "smithy.api#enumValue": "DeleteBucketAccessKey" } }, - "errorDetails": { - "target": "com.amazonaws.lightsail#string", + "UpdateBucketBundle": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The error details.
" + "smithy.api#enumValue": "UpdateBucketBundle" } - } - }, - "traits": { - "smithy.api#documentation": "Describes the API operation.
" - } - }, - "com.amazonaws.lightsail#OperationFailureException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "UpdateBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateBucket" + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "SetResourceAccessForBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SetResourceAccessForBucket" + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" + "UpdateInstanceMetadataOptions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateInstanceMetadataOptions" + } } - }, - "traits": { - "smithy.api#documentation": "Lightsail throws this exception when an operation fails to execute.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lightsail#OperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Operation" - } - }, - "com.amazonaws.lightsail#OperationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NotStarted", - "name": "NotStarted" - }, - { - "value": "Started", - "name": "Started" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Completed", - "name": "Completed" - }, - { - "value": "Succeeded", - "name": "Succeeded" - } - ] - } - }, - "com.amazonaws.lightsail#OperationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DeleteKnownHostKeys", - "name": "DeleteKnownHostKeys" - }, - { - "value": "DeleteInstance", - "name": "DeleteInstance" - }, - { - "value": "CreateInstance", - "name": "CreateInstance" - }, - { - "value": "StopInstance", - "name": "StopInstance" - }, - { - "value": "StartInstance", - "name": "StartInstance" - }, - { - "value": "RebootInstance", - "name": "RebootInstance" - }, - { - "value": "OpenInstancePublicPorts", - "name": "OpenInstancePublicPorts" - }, - { - "value": "PutInstancePublicPorts", - "name": "PutInstancePublicPorts" - }, - { - "value": "CloseInstancePublicPorts", - "name": "CloseInstancePublicPorts" - }, - { - "value": "AllocateStaticIp", - "name": "AllocateStaticIp" - }, - { - "value": "ReleaseStaticIp", - "name": "ReleaseStaticIp" - }, - { - "value": "AttachStaticIp", - "name": "AttachStaticIp" - }, - { - "value": "DetachStaticIp", - "name": "DetachStaticIp" - }, - { - "value": "UpdateDomainEntry", - "name": "UpdateDomainEntry" - }, - { - "value": "DeleteDomainEntry", - "name": "DeleteDomainEntry" - }, - { - "value": "CreateDomain", - "name": "CreateDomain" - }, - { - "value": "DeleteDomain", - "name": "DeleteDomain" - }, - { - "value": "CreateInstanceSnapshot", - "name": "CreateInstanceSnapshot" - }, - { - "value": "DeleteInstanceSnapshot", - "name": "DeleteInstanceSnapshot" - }, - { - "value": "CreateInstancesFromSnapshot", - "name": "CreateInstancesFromSnapshot" - }, - { - "value": "CreateLoadBalancer", - "name": "CreateLoadBalancer" - }, - { - "value": "DeleteLoadBalancer", - "name": "DeleteLoadBalancer" - }, - { - "value": "AttachInstancesToLoadBalancer", - "name": "AttachInstancesToLoadBalancer" - }, - { - "value": "DetachInstancesFromLoadBalancer", - "name": "DetachInstancesFromLoadBalancer" - }, - { - "value": "UpdateLoadBalancerAttribute", - "name": "UpdateLoadBalancerAttribute" - }, - { - "value": "CreateLoadBalancerTlsCertificate", - "name": "CreateLoadBalancerTlsCertificate" - }, - { - "value": "DeleteLoadBalancerTlsCertificate", - "name": "DeleteLoadBalancerTlsCertificate" - }, - { - "value": "AttachLoadBalancerTlsCertificate", - "name": "AttachLoadBalancerTlsCertificate" - }, - { - "value": "CreateDisk", - "name": "CreateDisk" - }, - { - "value": "DeleteDisk", - "name": "DeleteDisk" - }, - { - "value": "AttachDisk", - "name": "AttachDisk" - }, - { - "value": "DetachDisk", - "name": "DetachDisk" - }, - { - "value": "CreateDiskSnapshot", - "name": "CreateDiskSnapshot" - }, - { - "value": "DeleteDiskSnapshot", - "name": "DeleteDiskSnapshot" - }, - { - "value": "CreateDiskFromSnapshot", - "name": "CreateDiskFromSnapshot" - }, - { - "value": "CreateRelationalDatabase", - "name": "CreateRelationalDatabase" - }, - { - "value": "UpdateRelationalDatabase", - "name": "UpdateRelationalDatabase" - }, - { - "value": "DeleteRelationalDatabase", - "name": "DeleteRelationalDatabase" - }, - { - "value": "CreateRelationalDatabaseFromSnapshot", - "name": "CreateRelationalDatabaseFromSnapshot" - }, - { - "value": "CreateRelationalDatabaseSnapshot", - "name": "CreateRelationalDatabaseSnapshot" - }, - { - "value": "DeleteRelationalDatabaseSnapshot", - "name": "DeleteRelationalDatabaseSnapshot" - }, - { - "value": "UpdateRelationalDatabaseParameters", - "name": "UpdateRelationalDatabaseParameters" - }, - { - "value": "StartRelationalDatabase", - "name": "StartRelationalDatabase" - }, - { - "value": "RebootRelationalDatabase", - "name": "RebootRelationalDatabase" - }, - { - "value": "StopRelationalDatabase", - "name": "StopRelationalDatabase" - }, - { - "value": "EnableAddOn", - "name": "EnableAddOn" - }, - { - "value": "DisableAddOn", - "name": "DisableAddOn" - }, - { - "value": "PutAlarm", - "name": "PutAlarm" - }, - { - "value": "GetAlarms", - "name": "GetAlarms" - }, - { - "value": "DeleteAlarm", - "name": "DeleteAlarm" - }, - { - "value": "TestAlarm", - "name": "TestAlarm" - }, - { - "value": "CreateContactMethod", - "name": "CreateContactMethod" - }, - { - "value": "GetContactMethods", - "name": "GetContactMethods" - }, - { - "value": "SendContactMethodVerification", - "name": "SendContactMethodVerification" - }, - { - "value": "DeleteContactMethod", - "name": "DeleteContactMethod" - }, - { - "value": "CreateDistribution", - "name": "CreateDistribution" - }, - { - "value": "UpdateDistribution", - "name": "UpdateDistribution" - }, - { - "value": "DeleteDistribution", - "name": "DeleteDistribution" - }, - { - "value": "ResetDistributionCache", - "name": "ResetDistributionCache" - }, - { - "value": "AttachCertificateToDistribution", - "name": "AttachCertificateToDistribution" - }, - { - "value": "DetachCertificateFromDistribution", - "name": "DetachCertificateFromDistribution" - }, - { - "value": "UpdateDistributionBundle", - "name": "UpdateDistributionBundle" - }, - { - "value": "SetIpAddressType", - "name": "SetIpAddressType" - }, - { - "value": "CreateCertificate", - "name": "CreateCertificate" - }, - { - "value": "DeleteCertificate", - "name": "DeleteCertificate" - }, - { - "value": "CreateContainerService", - "name": "CreateContainerService" - }, - { - "value": "UpdateContainerService", - "name": "UpdateContainerService" - }, - { - "value": "DeleteContainerService", - "name": "DeleteContainerService" - }, - { - "value": "CreateContainerServiceDeployment", - "name": "CreateContainerServiceDeployment" - }, - { - "value": "CreateContainerServiceRegistryLogin", - "name": "CreateContainerServiceRegistryLogin" - }, - { - "value": "RegisterContainerImage", - "name": "RegisterContainerImage" - }, - { - "value": "DeleteContainerImage", - "name": "DeleteContainerImage" - }, - { - "value": "CreateBucket", - "name": "CreateBucket" - }, - { - "value": "DeleteBucket", - "name": "DeleteBucket" - }, - { - "value": "CreateBucketAccessKey", - "name": "CreateBucketAccessKey" - }, - { - "value": "DeleteBucketAccessKey", - "name": "DeleteBucketAccessKey" - }, - { - "value": "UpdateBucketBundle", - "name": "UpdateBucketBundle" - }, - { - "value": "UpdateBucket", - "name": "UpdateBucket" - }, - { - "value": "SetResourceAccessForBucket", - "name": "SetResourceAccessForBucket" - } - ] } }, "com.amazonaws.lightsail#Origin": { @@ -15775,18 +16528,20 @@ } }, "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "http-only", - "name": "HTTPOnly" - }, - { - "value": "https-only", - "name": "HTTPSOnly" + "type": "enum", + "members": { + "HTTPOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "http-only" + } + }, + "HTTPSOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https-only" } - ] + } } }, "com.amazonaws.lightsail#PartnerIdList": { @@ -15937,6 +16692,7 @@ "com.amazonaws.lightsail#Port": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": -1, "max": 65535 @@ -15944,18 +16700,20 @@ } }, "com.amazonaws.lightsail#PortAccessType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Public", - "name": "Public" - }, - { - "value": "Private", - "name": "Private" + "type": "enum", + "members": { + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Public" + } + }, + "Private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Private" } - ] + } } }, "com.amazonaws.lightsail#PortInfo": { @@ -15964,12 +16722,14 @@ "fromPort": { "target": "com.amazonaws.lightsail#Port", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The first port in a range of open ports on an instance.
\nAllowed ports:
\nTCP and UDP - 0 to 65535\n
ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the\n fromPort (ICMP type), and -1 as the toPort (ICMP\n code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as\n the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6\n code). For more information, see Internet\n Control Message Protocol for IPv6.
The last port in a range of open ports on an instance.
\nAllowed ports:
\nTCP and UDP - 0 to 65535\n
ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the\n fromPort (ICMP type), and -1 as the toPort (ICMP\n code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as\n the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6\n code). For more information, see Internet\n Control Message Protocol for IPv6.
The continent code (e.g., NA, meaning North America).
The continent code (e.g., NA, meaning North America).
The description of the AWS Region (e.g., This region is recommended to serve users\n in the eastern United States and eastern Canada).
The display name (e.g., Ohio).
The region name (e.g., us-east-2).
The Availability Zones. Follows the format us-east-2a\n (case-sensitive).
The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).
Describes the AWS Region.
" + } + }, + "com.amazonaws.lightsail#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Region" + } + }, + "com.amazonaws.lightsail#RegionName": { + "type": "enum", + "members": { + "US_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "US_EAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "US_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "US_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "EU_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "EU_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "EU_WEST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "EU_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "CA_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "AP_SOUTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" } }, - "description": { - "target": "com.amazonaws.lightsail#string", + "AP_SOUTHEAST_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The description of the AWS Region (e.g., This region is recommended to serve users\n in the eastern United States and eastern Canada).
The display name (e.g., Ohio).
The region name (e.g., us-east-2).
The Availability Zones. Follows the format us-east-2a\n (case-sensitive).
The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).
Describes the AWS Region.
" - } - }, - "com.amazonaws.lightsail#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Region" - } - }, - "com.amazonaws.lightsail#RegionName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "us-east-1", - "name": "US_EAST_1" - }, - { - "value": "us-east-2", - "name": "US_EAST_2" - }, - { - "value": "us-west-1", - "name": "US_WEST_1" - }, - { - "value": "us-west-2", - "name": "US_WEST_2" - }, - { - "value": "eu-west-1", - "name": "EU_WEST_1" - }, - { - "value": "eu-west-2", - "name": "EU_WEST_2" - }, - { - "value": "eu-west-3", - "name": "EU_WEST_3" - }, - { - "value": "eu-central-1", - "name": "EU_CENTRAL_1" - }, - { - "value": "ca-central-1", - "name": "CA_CENTRAL_1" - }, - { - "value": "ap-south-1", - "name": "AP_SOUTH_1" - }, - { - "value": "ap-southeast-1", - "name": "AP_SOUTHEAST_1" - }, - { - "value": "ap-southeast-2", - "name": "AP_SOUTHEAST_2" - }, - { - "value": "ap-northeast-1", - "name": "AP_NORTHEAST_1" - }, - { - "value": "ap-northeast-2", - "name": "AP_NORTHEAST_2" - }, - { - "value": "eu-north-1", - "name": "EU_NORTH_1" - } - ] } }, "com.amazonaws.lightsail#RegisterContainerImage": { @@ -16941,14 +17741,14 @@ } }, "com.amazonaws.lightsail#RelationalDatabaseEngine": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "mysql", - "name": "MYSQL" + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mysql" } - ] + } } }, "com.amazonaws.lightsail#RelationalDatabaseEvent": { @@ -17022,34 +17822,44 @@ } }, "com.amazonaws.lightsail#RelationalDatabaseMetricName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CPUUtilization", - "name": "CPUUtilization" - }, - { - "value": "DatabaseConnections", - "name": "DatabaseConnections" - }, - { - "value": "DiskQueueDepth", - "name": "DiskQueueDepth" - }, - { - "value": "FreeStorageSpace", - "name": "FreeStorageSpace" - }, - { - "value": "NetworkReceiveThroughput", - "name": "NetworkReceiveThroughput" - }, - { - "value": "NetworkTransmitThroughput", - "name": "NetworkTransmitThroughput" - } - ] + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "DatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DatabaseConnections" + } + }, + "DiskQueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskQueueDepth" + } + }, + "FreeStorageSpace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeStorageSpace" + } + }, + "NetworkReceiveThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkReceiveThroughput" + } + }, + "NetworkTransmitThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkTransmitThroughput" + } + } } }, "com.amazonaws.lightsail#RelationalDatabaseParameter": { @@ -17115,22 +17925,26 @@ } }, "com.amazonaws.lightsail#RelationalDatabasePasswordVersion": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CURRENT", - "name": "CURRENT" - }, - { - "value": "PREVIOUS", - "name": "PREVIOUS" - }, - { - "value": "PENDING", - "name": "PENDING" + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + } } }, "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { @@ -17301,26 +18115,32 @@ } }, "com.amazonaws.lightsail#RenewalStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PendingAutoRenewal", - "name": "PendingAutoRenewal" - }, - { - "value": "PendingValidation", - "name": "PendingValidation" - }, - { - "value": "Success", - "name": "Success" - }, - { - "value": "Failed", - "name": "Failed" - } - ] + "type": "enum", + "members": { + "PendingAutoRenewal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingAutoRenewal" + } + }, + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingValidation" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.lightsail#RenewalStatusReason": { @@ -17439,18 +18259,20 @@ } }, "com.amazonaws.lightsail#ResourceBucketAccess": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "allow", - "name": "Allow" - }, - { - "value": "deny", - "name": "Deny" + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" } - ] + }, + "Deny": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } } }, "com.amazonaws.lightsail#ResourceLocation": { @@ -17532,90 +18354,128 @@ } }, "com.amazonaws.lightsail#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ContainerService", - "name": "ContainerService" - }, - { - "value": "Instance", - "name": "Instance" - }, - { - "value": "StaticIp", - "name": "StaticIp" - }, - { - "value": "KeyPair", - "name": "KeyPair" - }, - { - "value": "InstanceSnapshot", - "name": "InstanceSnapshot" - }, - { - "value": "Domain", - "name": "Domain" - }, - { - "value": "PeeredVpc", - "name": "PeeredVpc" - }, - { - "value": "LoadBalancer", - "name": "LoadBalancer" - }, - { - "value": "LoadBalancerTlsCertificate", - "name": "LoadBalancerTlsCertificate" - }, - { - "value": "Disk", - "name": "Disk" - }, - { - "value": "DiskSnapshot", - "name": "DiskSnapshot" - }, - { - "value": "RelationalDatabase", - "name": "RelationalDatabase" - }, - { - "value": "RelationalDatabaseSnapshot", - "name": "RelationalDatabaseSnapshot" - }, - { - "value": "ExportSnapshotRecord", - "name": "ExportSnapshotRecord" - }, - { - "value": "CloudFormationStackRecord", - "name": "CloudFormationStackRecord" - }, - { - "value": "Alarm", - "name": "Alarm" - }, - { - "value": "ContactMethod", - "name": "ContactMethod" - }, - { - "value": "Distribution", - "name": "Distribution" - }, - { - "value": "Certificate", - "name": "Certificate" - }, - { - "value": "Bucket", - "name": "Bucket" - } - ] + "type": "enum", + "members": { + "ContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContainerService" + } + }, + "Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance" + } + }, + "StaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StaticIp" + } + }, + "KeyPair": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KeyPair" + } + }, + "InstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceSnapshot" + } + }, + "Domain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "PeeredVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PeeredVpc" + } + }, + "LoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoadBalancer" + } + }, + "LoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoadBalancerTlsCertificate" + } + }, + "Disk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disk" + } + }, + "DiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskSnapshot" + } + }, + "RelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RelationalDatabase" + } + }, + "RelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RelationalDatabaseSnapshot" + } + }, + "ExportSnapshotRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportSnapshotRecord" + } + }, + "CloudFormationStackRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormationStackRecord" + } + }, + "Alarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Alarm" + } + }, + "ContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContactMethod" + } + }, + "Distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Distribution" + } + }, + "Certificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Certificate" + } + }, + "Bucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bucket" + } + } } }, "com.amazonaws.lightsail#RevocationReason": { @@ -18055,18 +18915,20 @@ } }, "com.amazonaws.lightsail#StatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "Active" - }, - { - "value": "Inactive", - "name": "Inactive" + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" } - ] + } } }, "com.amazonaws.lightsail#StopInstance": { @@ -18416,26 +19278,32 @@ } }, "com.amazonaws.lightsail#TreatMissingData": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "breaching", - "name": "Breaching" - }, - { - "value": "notBreaching", - "name": "NotBreaching" - }, - { - "value": "ignore", - "name": "Ignore" - }, - { - "value": "missing", - "name": "Missing" - } - ] + "type": "enum", + "members": { + "Breaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "breaching" + } + }, + "NotBreaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "notBreaching" + } + }, + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignore" + } + }, + "Missing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "missing" + } + } } }, "com.amazonaws.lightsail#UnauthenticatedException": { @@ -19055,6 +19923,90 @@ } } }, + "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the Amazon Lightsail instance metadata parameters on a running or stopped\n instance. When you modify the parameters on a running instance, the GetInstance\n or GetInstances API operation initially responds with a state of\n pending. After the parameter modifications are successfully applied, the state\n changes to applied in subsequent GetInstance or\n GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.
The name of the instance for which to update metadata parameters.
", + "smithy.api#required": {} + } + }, + "httpTokens": { + "target": "com.amazonaws.lightsail#HttpTokens", + "traits": { + "smithy.api#documentation": "The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.
If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not\n specified, the existing state is maintained.
\n\nIf you specify a value of disabled, you cannot access your instance\n metadata.
The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther. If no parameter is specified,\n the existing state is maintained.
" + } + }, + "httpProtocolIpv6": { + "target": "com.amazonaws.lightsail#HttpProtocolIpv6", + "traits": { + "smithy.api#documentation": "Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only when the HTTP metadata endpoint is enabled.
\n\nThis parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across\n all AWS.
\nFormat example:\n arn:aws:geo:region:account-id:maps/ExampleMap\n
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across\n all AWS.
\nFormat example:\n arn:aws:geo:region:account-id:maps/ExampleMap\n
The name of the sprite file. Use the following file names for the sprite sheet:
\n\n sprites.png\n
\n sprites@2x.png for high pixel density displays
For the JSON document contain image offsets. Use the following file names:
\n\n sprites.json\n
\n sprites@2x.json for high pixel density displays
The name of the sprite file. Use the following file names for the sprite sheet:
\n\n sprites.png\n
\n sprites@2x.png for high pixel density displays
For the JSON document containing image offsets. Use the following file names:
\n\n sprites.json\n
\n sprites@2x.json for high pixel density displays
Finds a place by its unique ID. A PlaceId is returned by other search\n operations.
A PlaceId is valid only if all of the following are the same in the original\n search request and the call to GetPlace.
Customer AWS account
\nAWS Region
\nData provider specified in the place index resource
\nThe name of the place index resource that you want to use for the search.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaceId": { + "target": "com.amazonaws.location#PlaceId", + "traits": { + "smithy.api#documentation": "The identifier of the place to find.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results, but not the results\n themselves. If no language is specified, or not supported for a particular result, the\n partner automatically chooses a language for the result.
\nFor an example, we'll use the Greek language. You search for a location around Athens,\n Greece, with the language parameter set to en. The\n city in the results will most likely be returned as\n Athens.
If you set the language parameter to el, for Greek, then the\n city in the results will more likely be returned as\n Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.
", + "smithy.api#httpQuery": "language" + } + } + } + }, + "com.amazonaws.location#GetPlaceResponse": { + "type": "structure", + "members": { + "Place": { + "target": "com.amazonaws.location#Place", + "traits": { + "smithy.api#documentation": "Details about the result, such as its address and position.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.location#Id": { "type": "string", "traits": { @@ -5025,18 +5113,6 @@ }, "com.amazonaws.location#LocationService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Location", - "arnNamespace": "geo" - }, - "aws.auth#sigv4": { - "name": "geo" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "\"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing\"
", - "smithy.api#title": "Amazon Location Service" - }, "version": "2020-11-19", "resources": [ { @@ -5057,7 +5133,19 @@ { "target": "com.amazonaws.location#TrackerResource" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Location", + "arnNamespace": "geo" + }, + "aws.auth#sigv4": { + "name": "geo" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "\"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing\"
", + "smithy.api#title": "Amazon Location Service" + } }, "com.amazonaws.location#MapConfiguration": { "type": "structure", @@ -5201,10 +5289,22 @@ "traits": { "smithy.api#documentation": "The time zone in which the Place is located. Returned only when using\n Here as the selected partner.
For addresses with a UnitNumber, the type of unit. For example,\n Apartment.
For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.
Returned only for a place index that uses Esri as a data provider. Is not returned\n for SearchPlaceIndexForPosition.
Contains details about addresses or points of interest that match the search\n criteria.
\nNot all details are included with all responses. Some details may only be returned \n by specific data partners.
" + "smithy.api#documentation": "Contains details about addresses or points of interest that match the search\n criteria.
\nNot all details are included with all responses. Some details may only be returned by\n specific data partners.
" } }, "com.amazonaws.location#PlaceGeometry": { @@ -5221,6 +5321,9 @@ "smithy.api#documentation": "Places uses a point geometry to specify a location or a Place.
" } }, + "com.amazonaws.location#PlaceId": { + "type": "string" + }, "com.amazonaws.location#PlaceIndexResource": { "type": "resource", "identifiers": { @@ -5244,6 +5347,9 @@ "target": "com.amazonaws.location#ListPlaceIndexes" }, "operations": [ + { + "target": "com.amazonaws.location#GetPlace" + }, { "target": "com.amazonaws.location#SearchPlaceIndexForPosition" }, @@ -5264,6 +5370,7 @@ "com.amazonaws.location#PlaceIndexSearchResultLimit": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -5652,6 +5759,12 @@ }, "smithy.api#required": {} } + }, + "PlaceId": { + "target": "com.amazonaws.location#PlaceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the place. You can use this with the GetPlace\n operation to find the place again later.
For SearchPlaceIndexForPosition operations, the PlaceId\n is returned only by place indexes that use HERE as a data provider.
The text of the place suggestion, typically formatted as an address string.
", "smithy.api#required": {} } + }, + "PlaceId": { + "target": "com.amazonaws.location#PlaceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the place. You can use this with the GetPlace\n operation to find the place again later.
For SearchPlaceIndexForSuggestions operations, the\n PlaceId is\n returned\n by place indexes that use HERE or Esri as data providers.
The unique identifier of the place. You can use this with the GetPlace\n operation to find the place again later.
For SearchPlaceIndexForText operations, the PlaceId is\n returned only by place indexes that use HERE as a data provider.
An optional parameter. The maximum number of results returned per request.
\nDefault value: 50\n
Contains the optional result count limit that is specified in the request.
\nDefault value: 50\n
An optional parameter. The maximum number of results returned per request.
\nThe default: 50\n
A list of Places matching the input text. Each result contains additional information\n about the specific point of interest.
\nNot all response properties are included with all responses. Some properties may \n only be returned by specific data partners.
", + "smithy.api#documentation": "A list of Places matching the input text. Each result contains additional information\n about the specific point of interest.
\nNot all response properties are included with all responses. Some properties may only\n be returned by specific data partners.
", "smithy.api#required": {} } } @@ -6154,6 +6282,7 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Contains the optional result count limit specified in the request.
" } }, @@ -6804,7 +6933,7 @@ } }, "MapArn": { - "target": "com.amazonaws.location#Arn", + "target": "com.amazonaws.location#GeoArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource\n across AWS.
\nFormat example: arn:aws:geo:region:account-id:maps/ExampleMap\n
This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the AWS SDKs to\n access an API that is tailored to the programming language or platform that you're\n using.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#title": "AWS Migration Hub Orchestrator" + } + }, + "com.amazonaws.migrationhuborchestrator#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ApplicationConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#CreateMigrationWorkflowRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the migration workflow.
", + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+, ]*$" + } + }, + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$", + "smithy.api#required": {} + } + }, + "applicationConfigurationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The configuration ID of the application configured in Application Discovery Service.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$", + "smithy.api#required": {} + } + }, + "inputParameters": { + "target": "com.amazonaws.migrationhuborchestrator#StepInputParameters", + "traits": { + "smithy.api#documentation": "The input parameters required to create a migration workflow.
", + "smithy.api#required": {} + } + }, + "stepTargets": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + }, + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#StringMap", + "traits": { + "smithy.api#documentation": "The tags to add on a migration workflow.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateMigrationWorkflowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the migration workflow.
" + } + }, + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "adsApplicationConfigurationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The configuration ID of the application configured in Application Discovery Service.
" + } + }, + "workflowInputs": { + "target": "com.amazonaws.migrationhuborchestrator#StepInputParameters", + "traits": { + "smithy.api#documentation": "The inputs for creating a migration workflow.
" + } + }, + "stepTargets": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was created.
" + } + }, + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#StringMap", + "traits": { + "smithy.api#documentation": "The tags to add on a migration workflow.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#CreateMigrationWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#CreateMigrationWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a workflow to orchestrate your migrations.
", + "smithy.api#http": { + "method": "POST", + "uri": "/migrationworkflow/", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflowStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a step in the migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workflowstep", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepGroupRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a step group in a migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workflowstepgroups", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepGroupRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow that will contain the step group.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupName", + "traits": { + "smithy.api#documentation": "The name of the step group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupDescription", + "traits": { + "smithy.api#documentation": "The description of the step group.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepGroupResponse": { + "type": "structure", + "members": { + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow that contains the step group.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step group.
" + } + }, + "tools": { + "target": "com.amazonaws.migrationhuborchestrator#ToolsList", + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group is created.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowName", + "traits": { + "smithy.api#documentation": "The name of the step.
", + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#required": {} + } + }, + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#required": {} + } + }, + "stepActionType": { + "target": "com.amazonaws.migrationhuborchestrator#StepActionType", + "traits": { + "smithy.api#documentation": "The action type of the step. You must run and update the status of a manual step for\n the workflow to continue after the completion of the step.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowDescription", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, + "workflowStepAutomationConfiguration": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepAutomationConfiguration", + "traits": { + "smithy.api#documentation": "The custom script to run tests on source or target environments.
" + } + }, + "stepTarget": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + }, + "outputs": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputList", + "traits": { + "smithy.api#documentation": "The key value pairs added for the expected output.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepResponse": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "stepGroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#DataType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "INTEGER", + "name": "INTEGER" + }, + { + "value": "STRINGLIST", + "name": "STRINGLIST" + }, + { + "value": "STRINGMAP", + "name": "STRINGMAP" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteMigrationWorkflowRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteMigrationWorkflowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteMigrationWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteMigrationWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to\n delete it.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/migrationworkflow/{id}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a step in a migration workflow. Pause the workflow to delete a running\n step.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workflowstep/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepGroupRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a step group in a migration workflow.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workflowstepgroup/{id}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepGroupRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepGroupResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group that contains the step you want to delete.
", + "smithy.api#httpQuery": "stepGroupId", + "smithy.api#required": {} + } + }, + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the migration workflow.
" + } + }, + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "adsApplicationConfigurationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The configuration ID of the application configured in Application Discovery Service.
" + } + }, + "adsApplicationName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the application configured in Application Discovery Service.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status message of the migration workflow.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was created.
" + } + }, + "lastStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was last started.
" + } + }, + "lastStopTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was last stopped.
" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was last modified.
" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow ended.
" + } + }, + "tools": { + "target": "com.amazonaws.migrationhuborchestrator#ToolsList", + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "totalSteps": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of steps in the migration workflow.
" + } + }, + "completedSteps": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Get a list of completed steps in the migration workflow.
" + } + }, + "workflowInputs": { + "target": "com.amazonaws.migrationhuborchestrator#StepInputParameters", + "traits": { + "smithy.api#documentation": "The inputs required for creating the migration workflow.
" + } + }, + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#StringMap", + "traits": { + "smithy.api#documentation": "The tags added to the migration workflow.
" + } + }, + "workflowBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket where the migration logs are stored.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowTemplateResponse": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the template.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The time at which the template was last created.
" + } + }, + "inputs": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateInputList", + "traits": { + "smithy.api#documentation": "The inputs provided for the creation of the migration workflow.
" + } + }, + "tools": { + "target": "com.amazonaws.migrationhuborchestrator#ToolsList", + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the template.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the template was last created.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowTemplateRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get the template you want to use for creating a migration workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/migrationworkflowtemplate/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplateStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplateStepRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplateStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a specific step in a template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/templatestep/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplateStepGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplateStepGroupRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplateStepGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a step group in a template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/templates/{templateId}/stepgroups/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplateStepGroupRequest": { + "type": "structure", + "members": { + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplateStepGroupResponse": { + "type": "structure", + "members": { + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step group.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupStatus", + "traits": { + "smithy.api#documentation": "The status of the step group.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group was created.
" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group was last modified.
" + } + }, + "tools": { + "target": "com.amazonaws.migrationhuborchestrator#ToolsList", + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplateStepRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#httpQuery": "templateId", + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpQuery": "stepGroupId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetTemplateStepResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, + "stepActionType": { + "target": "com.amazonaws.migrationhuborchestrator#StepActionType", + "traits": { + "smithy.api#documentation": "The action type of the step. You must run and update the status of a manual step for\n the workflow to continue after the completion of the step.
" + } + }, + "creationTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The time at which the step was created.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step.
" + } + }, + "outputs": { + "target": "com.amazonaws.migrationhuborchestrator#StepOutputList", + "traits": { + "smithy.api#documentation": "The outputs of the step.
" + } + }, + "stepAutomationConfiguration": { + "target": "com.amazonaws.migrationhuborchestrator#StepAutomationConfiguration", + "traits": { + "smithy.api#documentation": "The custom script to run tests on source or target environments.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#GetMigrationWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get migration workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/migrationworkflow/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflowStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflowStepRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflowStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get a step in the migration workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workflowstep/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflowStepGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflowStepGroupRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflowStepGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the step group of a migration workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workflowstepgroup/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflowStepGroupRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflowStepGroupResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step group.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupStatus", + "traits": { + "smithy.api#documentation": "The status of the step group.
" + } + }, + "owner": { + "target": "com.amazonaws.migrationhuborchestrator#Owner", + "traits": { + "smithy.api#documentation": "The owner of the step group.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group was created.
" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group was last modified.
" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group ended.
" + } + }, + "tools": { + "target": "com.amazonaws.migrationhuborchestrator#ToolsList", + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflowStepRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "desThe ID of the step group.
", + "smithy.api#httpQuery": "stepGroupId", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#GetWorkflowStepResponse": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "stepGroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "stepId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, + "stepActionType": { + "target": "com.amazonaws.migrationhuborchestrator#StepActionType", + "traits": { + "smithy.api#documentation": "The action type of the step. You must run and update the status of a manual step for\n the workflow to continue after the completion of the step.
" + } + }, + "owner": { + "target": "com.amazonaws.migrationhuborchestrator#Owner", + "traits": { + "smithy.api#documentation": "The owner of the step.
" + } + }, + "workflowStepAutomationConfiguration": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepAutomationConfiguration", + "traits": { + "smithy.api#documentation": "The custom script to run tests on source or target environments.
" + } + }, + "stepTarget": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + }, + "outputs": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputList", + "traits": { + "smithy.api#documentation": "The outputs of the step.
", + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepStatus", + "traits": { + "smithy.api#documentation": "The status of the step.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status message of the migration workflow.
" + } + }, + "scriptOutputLocation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The output location of the script.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step was created.
" + } + }, + "lastStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the workflow was last started.
" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step ended.
" + } + }, + "noOfSrvCompleted": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of servers that have been migrated.
" + } + }, + "noOfSrvFailed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of servers that have failed to migrate.
" + } + }, + "totalNoOfSrv": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of servers that have been migrated.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "com.amazonaws.migrationhuborchestrator#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An internal error has occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowTemplatesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "name": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateName", + "traits": { + "smithy.api#documentation": "The name of the template.
", + "smithy.api#httpQuery": "name" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowTemplatesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "templateSummary": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateSummaryList", + "traits": { + "smithy.api#documentation": "The summary of the template.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#httpQuery": "templateId" + } + }, + "adsApplicationConfigurationName": { + "target": "com.amazonaws.migrationhuborchestrator#ApplicationConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the application configured in Application Discovery Service.
", + "smithy.api#httpQuery": "adsApplicationConfigurationName" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
", + "smithy.api#httpQuery": "status" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
", + "smithy.api#httpQuery": "name" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "migrationWorkflowSummary": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowSummaryList", + "traits": { + "smithy.api#documentation": "The summary of the migration workflow.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListPlugins": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListPluginsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListPluginsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List AWS Migration Hub Orchestrator plugins.
", + "smithy.api#http": { + "method": "GET", + "uri": "/plugins", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "plugins" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListPluginsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of plugins that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListPluginsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "plugins": { + "target": "com.amazonaws.migrationhuborchestrator#PluginSummaries", + "traits": { + "smithy.api#documentation": "Migration Hub Orchestrator plugins.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the tags added to a resource.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.migrationhuborchestrator#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#TagMap", + "traits": { + "smithy.api#documentation": "The tags added to a resource.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplateStepGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplateStepGroupsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplateStepGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "List the step groups in a template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/templatestepgroups/{templateId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "templateStepGroupSummary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplateStepGroupsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplateStepGroupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "templateStepGroupSummary": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateStepGroupSummaryList", + "traits": { + "smithy.api#documentation": "The summary of the step group in the template.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplateSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplateStepsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplateStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the steps in a template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/templatesteps", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "templateStepSummaryList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplateStepsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the template.
", + "smithy.api#httpQuery": "templateId", + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpQuery": "stepGroupId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplateStepsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "templateStepSummaryList": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateStepSummaryList", + "traits": { + "smithy.api#documentation": "The list of summaries of steps in a template.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "List the templates available in Migration Hub Orchestrator to create a migration workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/migrationworkflowtemplates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "templateSummary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflowStepGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflowStepGroupsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflowStepGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the step groups in a migration workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workflowstepgroups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "workflowStepGroupsSummary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflowStepGroupsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflowStepGroupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "workflowStepGroupsSummary": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepGroupsSummaryList", + "traits": { + "smithy.api#documentation": "The summary of step groups in a migration workflow.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflowSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflowStepsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflowStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the steps in a workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workflow/{workflowId}/workflowstepgroups/{stepGroupId}/workflowsteps", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "workflowStepsSummary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflowStepsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.migrationhuborchestrator#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflowStepsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhuborchestrator#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token.
" + } + }, + "workflowStepsSummary": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepsSummaryList", + "traits": { + "smithy.api#documentation": "The summary of steps in a migration workflow.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ListWorkflows": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#ListMigrationWorkflowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the migration workflows.
", + "smithy.api#http": { + "method": "GET", + "uri": "/migrationworkflows", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "migrationWorkflowSummary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhuborchestrator#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflow": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId" + } + }, + "create": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflow" + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflow" + }, + "update": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflow" + }, + "delete": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflow" + }, + "list": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflows" + }, + "operations": [ + { + "target": "com.amazonaws.migrationhuborchestrator#StartWorkflow" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#StopWorkflow" + } + ] + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+, ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "CREATION_FAILED", + "name": "CREATION_FAILED" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "WORKFLOW_FAILED", + "name": "WORKFLOW_FAILED" + }, + { + "value": "PAUSED", + "name": "PAUSED" + }, + { + "value": "PAUSING", + "name": "PAUSING" + }, + { + "value": "PAUSING_FAILED", + "name": "PAUSING_FAILED" + }, + { + "value": "USER_ATTENTION_REQUIRED", + "name": "USER_ATTENTION_REQUIRED" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "DELETION_FAILED", + "name": "DELETION_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
" + } + }, + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "adsApplicationConfigurationName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the application configured in Application Discovery Service.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was created.
" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow ended.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status message of the migration workflow.
" + } + }, + "completedSteps": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The steps completed in the migration workflow.
" + } + }, + "totalSteps": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "All the steps in a migration workflow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of a migration workflow.
" + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowSummary" + } + }, + "com.amazonaws.migrationhuborchestrator#MigrationWorkflowTemplate": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId" + } + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplate" + }, + "list": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplates" + } + }, + "com.amazonaws.migrationhuborchestrator#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhuborchestrator#Owner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_MANAGED", + "name": "AWSManaged" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#PlatformCommand": { + "type": "structure", + "members": { + "linux": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Command for Linux.
" + } + }, + "windows": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Command for Windows.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Command to be run on a particular operating system.
" + } + }, + "com.amazonaws.migrationhuborchestrator#PlatformScriptKey": { + "type": "structure", + "members": { + "linux": { + "target": "com.amazonaws.migrationhuborchestrator#S3Key", + "traits": { + "smithy.api#documentation": "The script location for Linux.
" + } + }, + "windows": { + "target": "com.amazonaws.migrationhuborchestrator#S3Key", + "traits": { + "smithy.api#documentation": "The script location for Windows.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The script location for a particular operating system.
" + } + }, + "com.amazonaws.migrationhuborchestrator#Plugin": { + "type": "resource", + "identifiers": { + "pluginId": { + "target": "com.amazonaws.migrationhuborchestrator#PluginId" + } + }, + "list": { + "target": "com.amazonaws.migrationhuborchestrator#ListPlugins" + } + }, + "com.amazonaws.migrationhuborchestrator#PluginHealth": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HEALTHY", + "name": "PLUGIN_HEALTHY" + }, + { + "value": "UNHEALTHY", + "name": "PLUGIN_UNHEALTHY" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#PluginId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhuborchestrator#PluginSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#PluginSummary" + } + }, + "com.amazonaws.migrationhuborchestrator#PluginSummary": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.migrationhuborchestrator#PluginId", + "traits": { + "smithy.api#documentation": "The ID of the plugin.
" + } + }, + "hostname": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the host.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#PluginHealth", + "traits": { + "smithy.api#documentation": "The status of the plugin.
" + } + }, + "ipAddress": { + "target": "com.amazonaws.migrationhuborchestrator#IPAddress", + "traits": { + "smithy.api#documentation": "The IP address at which the plugin is located.
" + } + }, + "version": { + "target": "com.amazonaws.migrationhuborchestrator#PluginVersion", + "traits": { + "smithy.api#documentation": "The version of the plugin.
" + } + }, + "registeredTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The time at which the plugin was registered.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the Migration Hub Orchestrator plugin.
" + } + }, + "com.amazonaws.migrationhuborchestrator#PluginVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.migrationhuborchestrator#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:migrationhub-orchestrator:[a-z0-9-]+:[0-9]+:workflow/[.]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The resource is not available.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.migrationhuborchestrator#RetryWorkflowStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#RetryWorkflowStepRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#RetryWorkflowStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retry a failed step in a migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/retryworkflowstep/{id}", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#RetryWorkflowStepRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpQuery": "stepGroupId", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#RetryWorkflowStepResponse": { + "type": "structure", + "members": { + "stepGroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepStatus", + "traits": { + "smithy.api#documentation": "The status of the step.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#RunEnvironment": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS", + "name": "AWS" + }, + { + "value": "ONPREMISE", + "name": "ONPREMISE" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.migrationhuborchestrator#StartMigrationWorkflowRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#StartMigrationWorkflowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status message of the migration workflow.
" + } + }, + "lastStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was last started.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#StartWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#StartMigrationWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#StartMigrationWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Start a migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/migrationworkflow/{id}/start", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#StepActionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANUAL", + "name": "MANUAL" + }, + { + "value": "AUTOMATED", + "name": "AUTOMATED" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#StepAutomationConfiguration": { + "type": "structure", + "members": { + "scriptLocationS3Bucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket where the script is located.
" + } + }, + "scriptLocationS3Key": { + "target": "com.amazonaws.migrationhuborchestrator#PlatformScriptKey", + "traits": { + "smithy.api#documentation": "The Amazon S3 key for the script location.
" + } + }, + "command": { + "target": "com.amazonaws.migrationhuborchestrator#PlatformCommand", + "traits": { + "smithy.api#documentation": "The command to run the script.
" + } + }, + "runEnvironment": { + "target": "com.amazonaws.migrationhuborchestrator#RunEnvironment", + "traits": { + "smithy.api#documentation": "The source or target environment.
" + } + }, + "targetType": { + "target": "com.amazonaws.migrationhuborchestrator#TargetType", + "traits": { + "smithy.api#documentation": "The servers on which to run the script.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The custom script to run tests on source or target environments.
" + } + }, + "com.amazonaws.migrationhuborchestrator#StepDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+, ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepGroupDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+, ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepGroupStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWAITING_DEPENDENCIES", + "name": "AWAITING_DEPENDENCIES" + }, + { + "value": "READY", + "name": "READY" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "PAUSED", + "name": "PAUSED" + }, + { + "value": "PAUSING", + "name": "PAUSING" + }, + { + "value": "USER_ATTENTION_REQUIRED", + "name": "USER_ATTENTION_REQUIRED" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#StepId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepInput": { + "type": "union", + "members": { + "integerValue": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The value of the integer.
" + } + }, + "stringValue": { + "target": "com.amazonaws.migrationhuborchestrator#StringValue", + "traits": { + "smithy.api#documentation": "String value.
" + } + }, + "listOfStringsValue": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "List of string values.
" + } + }, + "mapOfStringValue": { + "target": "com.amazonaws.migrationhuborchestrator#StringMap", + "traits": { + "smithy.api#documentation": "Map of string values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A map of key value pairs that is generated when you create a migration workflow. The\n key value pairs will differ based on your selection of the template.
" + } + }, + "com.amazonaws.migrationhuborchestrator#StepInputParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.migrationhuborchestrator#StepInputParametersKey" + }, + "value": { + "target": "com.amazonaws.migrationhuborchestrator#StepInput" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.migrationhuborchestrator#StepInputParametersKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_ ()]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#StepOutput": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "dataType": { + "target": "com.amazonaws.migrationhuborchestrator#DataType", + "traits": { + "smithy.api#documentation": "The data type of the step output.
" + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Determine if an output is required from a step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output of the step.
" + } + }, + "com.amazonaws.migrationhuborchestrator#StepOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#StepOutput" + } + }, + "com.amazonaws.migrationhuborchestrator#StepStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWAITING_DEPENDENCIES", + "name": "AWAITING_DEPENDENCIES" + }, + { + "value": "READY", + "name": "READY" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "PAUSED", + "name": "PAUSED" + }, + { + "value": "USER_ATTENTION_REQUIRED", + "name": "USER_ATTENTION_REQUIRED" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#StopMigrationWorkflowRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#StopMigrationWorkflowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status message of the migration workflow.
" + } + }, + "lastStopTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was stopped.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#StopWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#StopMigrationWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#StopMigrationWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stop an ongoing migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/migrationworkflow/{id}/stop", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#StringListMember" + } + }, + "com.amazonaws.migrationhuborchestrator#StringListMember": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.migrationhuborchestrator#StringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.migrationhuborchestrator#StringMapKey" + }, + "value": { + "target": "com.amazonaws.migrationhuborchestrator#StringMapValue" + } + }, + "com.amazonaws.migrationhuborchestrator#StringMapKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_ ()]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#StringMapValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.migrationhuborchestrator#StringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.migrationhuborchestrator#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.migrationhuborchestrator#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.migrationhuborchestrator#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.migrationhuborchestrator#TagKey" + }, + "value": { + "target": "com.amazonaws.migrationhuborchestrator#TagValue" + } + }, + "com.amazonaws.migrationhuborchestrator#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tag a resource by specifying its Amazon Resource Name (ARN).
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.migrationhuborchestrator#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which you want to add tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#TagMap", + "traits": { + "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhuborchestrator#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.migrationhuborchestrator#TargetType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SINGLE", + "name": "SINGLE" + }, + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateInput": { + "type": "structure", + "members": { + "inputName": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateInputName", + "traits": { + "smithy.api#documentation": "The name of the template.
" + } + }, + "dataType": { + "target": "com.amazonaws.migrationhuborchestrator#DataType", + "traits": { + "smithy.api#documentation": "The data type of the template input.
" + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Determine if an input is required from the template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input parameters of a template.
" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateInput" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateInputName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + } + ] + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStep": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId" + } + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplateStep" + }, + "list": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplateSteps" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStepGroup": { + "type": "resource", + "identifiers": { + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId" + }, + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId" + } + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#GetTemplateStepGroup" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStepGroupSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the step group in the template.
" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStepGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateStepGroupSummary" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStepGroups": { + "type": "resource", + "identifiers": { + "templateId": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId" + } + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#ListTemplateStepGroups" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStepSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "stepGroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "stepActionType": { + "target": "com.amazonaws.migrationhuborchestrator#StepActionType", + "traits": { + "smithy.api#documentation": "The action type of the step. You must run and update the status of a manual step for\n the workflow to continue after the completion of the step.
" + } + }, + "targetType": { + "target": "com.amazonaws.migrationhuborchestrator#TargetType", + "traits": { + "smithy.api#documentation": "The servers on which to run the script.
" + } + }, + "owner": { + "target": "com.amazonaws.migrationhuborchestrator#Owner", + "traits": { + "smithy.api#documentation": "The owner of the step.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the step.
" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateStepSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateStepSummary" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the template.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the template.
" + } + }, + "com.amazonaws.migrationhuborchestrator#TemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateSummary" + } + }, + "com.amazonaws.migrationhuborchestrator#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.migrationhuborchestrator#Tool": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of an AWS service.
" + } + }, + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL of an AWS service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "com.amazonaws.migrationhuborchestrator#ToolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#Tool" + } + }, + "com.amazonaws.migrationhuborchestrator#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the tags for a resource.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.migrationhuborchestrator#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which you want to remove\n tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.migrationhuborchestrator#TagKeyList", + "traits": { + "smithy.api#documentation": "One or more tag keys. Specify only the tag keys, not the tag values.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhuborchestrator#UpdateMigrationWorkflowRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the migration workflow.
", + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+, ]*$" + } + }, + "inputParameters": { + "target": "com.amazonaws.migrationhuborchestrator#StepInputParameters", + "traits": { + "smithy.api#documentation": "The input parameters required to update a migration workflow.
" + } + }, + "stepTargets": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateMigrationWorkflowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the migration workflow.
" + } + }, + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the template.
" + } + }, + "adsApplicationConfigurationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the application configured in Application Discovery Service.
" + } + }, + "workflowInputs": { + "target": "com.amazonaws.migrationhuborchestrator#StepInputParameters", + "traits": { + "smithy.api#documentation": "The inputs required to update a migration workflow.
" + } + }, + "stepTargets": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the migration workflow.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was created.
" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the migration workflow was last modified.
" + } + }, + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#StringMap", + "traits": { + "smithy.api#documentation": "The tags added to the migration workflow.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateMigrationWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateMigrationWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update a migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/migrationworkflow/{id}", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update a step in a migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workflowstep/{id}", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepGroupRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the step group in a migration workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workflowstepgroup/{id}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepGroupRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupName", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "description": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupDescription", + "traits": { + "smithy.api#documentation": "The description of the step group.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepGroupResponse": { + "type": "structure", + "members": { + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step group.
" + } + }, + "tools": { + "target": "com.amazonaws.migrationhuborchestrator#ToolsList", + "traits": { + "smithy.api#documentation": "List of AWS services utilized in a migration workflow.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the step group was last modified.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stepGroupId": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", + "traits": { + "smithy.api#documentation": "The ID of the step group.
", + "smithy.api#required": {} + } + }, + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.migrationhuborchestrator#StepName", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "description": { + "target": "com.amazonaws.migrationhuborchestrator#StepDescription", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, + "stepActionType": { + "target": "com.amazonaws.migrationhuborchestrator#StepActionType", + "traits": { + "smithy.api#documentation": "The action type of the step. You must run and update the status of a manual step for\n the workflow to continue after the completion of the step.
" + } + }, + "workflowStepAutomationConfiguration": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepAutomationConfiguration", + "traits": { + "smithy.api#documentation": "The custom script to run tests on the source and target environments.
" + } + }, + "stepTarget": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The servers on which a step will be run.
" + } + }, + "outputs": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputList", + "traits": { + "smithy.api#documentation": "The outputs of a step.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepStatus", + "traits": { + "smithy.api#documentation": "The status of the step.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "stepGroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "workflowId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + } + } + }, + "com.amazonaws.migrationhuborchestrator#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStep": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepId" + } + }, + "create": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflowStep" + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflowStep" + }, + "update": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStep" + }, + "delete": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStep" + }, + "list": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflowSteps" + }, + "operations": [ + { + "target": "com.amazonaws.migrationhuborchestrator#RetryWorkflowStep" + } + ] + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepAutomationConfiguration": { + "type": "structure", + "members": { + "scriptLocationS3Bucket": { + "target": "com.amazonaws.migrationhuborchestrator#S3Bucket", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket where the script is located.
" + } + }, + "scriptLocationS3Key": { + "target": "com.amazonaws.migrationhuborchestrator#PlatformScriptKey", + "traits": { + "smithy.api#documentation": "The Amazon S3 key for the script location.
" + } + }, + "command": { + "target": "com.amazonaws.migrationhuborchestrator#PlatformCommand", + "traits": { + "smithy.api#documentation": "The command required to run the script.
" + } + }, + "runEnvironment": { + "target": "com.amazonaws.migrationhuborchestrator#RunEnvironment", + "traits": { + "smithy.api#documentation": "The source or target environment.
" + } + }, + "targetType": { + "target": "com.amazonaws.migrationhuborchestrator#TargetType", + "traits": { + "smithy.api#documentation": "The servers on which to run the script.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The custom script to run tests on source or target environments.
" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepGroup": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupId" + } + }, + "create": { + "target": "com.amazonaws.migrationhuborchestrator#CreateWorkflowStepGroup" + }, + "read": { + "target": "com.amazonaws.migrationhuborchestrator#GetWorkflowStepGroup" + }, + "update": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateWorkflowStepGroup" + }, + "delete": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteWorkflowStepGroup" + }, + "list": { + "target": "com.amazonaws.migrationhuborchestrator#ListWorkflowStepGroups" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepGroupSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step group.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step group.
" + } + }, + "owner": { + "target": "com.amazonaws.migrationhuborchestrator#Owner", + "traits": { + "smithy.api#documentation": "The owner of the step group.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepGroupStatus", + "traits": { + "smithy.api#documentation": "The status of the step group.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step group.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of a step group in a workflow.
" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepGroupsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepGroupSummary" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepOutput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputName", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "dataType": { + "target": "com.amazonaws.migrationhuborchestrator#DataType", + "traits": { + "smithy.api#documentation": "The data type of the output.
" + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Determine if an output is required from a step.
" + } + }, + "value": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputUnion", + "traits": { + "smithy.api#documentation": "The value of the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output of a step.
" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepOutput" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepOutputUnion": { + "type": "union", + "members": { + "integerValue": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The integer value.
" + } + }, + "stringValue": { + "target": "com.amazonaws.migrationhuborchestrator#StringValue", + "traits": { + "smithy.api#documentation": "The string value.
" + } + }, + "listOfStringValue": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The list of string value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure to hold multiple values of an output.
" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepSummary": { + "type": "structure", + "members": { + "stepId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the step.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "stepActionType": { + "target": "com.amazonaws.migrationhuborchestrator#StepActionType", + "traits": { + "smithy.api#documentation": "The action type of the step. You must run and update the status of a manual step for\n the workflow to continue after the completion of the step.
" + } + }, + "owner": { + "target": "com.amazonaws.migrationhuborchestrator#Owner", + "traits": { + "smithy.api#documentation": "The owner of the step.
" + } + }, + "previous": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The previous step.
" + } + }, + "next": { + "target": "com.amazonaws.migrationhuborchestrator#StringList", + "traits": { + "smithy.api#documentation": "The next step.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhuborchestrator#StepStatus", + "traits": { + "smithy.api#documentation": "The status of the step.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status message of the migration workflow.
" + } + }, + "noOfSrvCompleted": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of servers that have been migrated.
" + } + }, + "noOfSrvFailed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of servers that have failed to migrate.
" + } + }, + "totalNoOfSrv": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of servers that have been migrated.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, + "scriptLocation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The location of the script.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the step in a migration workflow.
" + } + }, + "com.amazonaws.migrationhuborchestrator#WorkflowStepsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#WorkflowStepSummary" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/nimble.json b/codegen/sdk/aws-models/nimble.json index c19d43c72f1..f83bf01de31 100644 --- a/codegen/sdk/aws-models/nimble.json +++ b/codegen/sdk/aws-models/nimble.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "shapes": { "com.amazonaws.nimble#AcceptEulas": { "type": "operation", @@ -62,11 +62,14 @@ "studioId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "A collection of EULA IDs.
", + "smithy.api#documentation": "The studio ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#AcceptEulasResponse": { @@ -78,6 +81,9 @@ "smithy.api#documentation": "A collection of EULA acceptances.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#AccessDeniedException": { @@ -396,6 +402,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -412,6 +419,9 @@ "smithy.api#documentation": "The launch profile.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#CreateStreamingImage": { @@ -516,6 +526,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -532,6 +543,9 @@ "smithy.api#documentation": "The streaming image.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#CreateStreamingSession": { @@ -637,6 +651,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#LaunchProfileResource" @@ -653,6 +668,9 @@ "smithy.api#documentation": "The session.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#CreateStreamingSessionStream": { @@ -714,6 +732,7 @@ "expirationInSeconds": { "target": "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The expiration time in seconds.
" } }, @@ -735,6 +754,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StreamingSessionResource" @@ -751,6 +771,9 @@ "smithy.api#documentation": "The stream.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#CreateStudio": { @@ -936,24 +959,19 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" } } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -970,6 +988,9 @@ "smithy.api#documentation": "Information about the studio component.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#CreateStudioRequest": { @@ -1027,6 +1048,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#CreateStudioResponse": { @@ -1038,6 +1062,9 @@ "smithy.api#documentation": "Information about a studio.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#DeleteLaunchProfile": { @@ -1146,7 +1173,7 @@ "principalId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The principal ID. This currently supports a Amazon Web Services SSO UserId.
", + "smithy.api#documentation": "The principal ID. This currently supports a IAM Identity Center UserId.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1159,11 +1186,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteLaunchProfileMemberResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.nimble#DeleteLaunchProfileRequest": { "type": "structure", @@ -1193,6 +1226,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteLaunchProfileResponse": { @@ -1204,6 +1240,9 @@ "smithy.api#documentation": "The launch profile.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#DeleteStreamingImage": { @@ -1282,6 +1321,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteStreamingImageResponse": { @@ -1293,6 +1335,9 @@ "smithy.api#documentation": "The streaming image.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#DeleteStreamingSession": { @@ -1370,6 +1415,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteStreamingSessionResponse": { @@ -1381,6 +1429,9 @@ "smithy.api#documentation": "The session.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#DeleteStudio": { @@ -1498,6 +1549,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteStudioComponentResponse": { @@ -1509,6 +1563,9 @@ "smithy.api#documentation": "Information about the studio component.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#DeleteStudioMember": { @@ -1567,7 +1624,7 @@ "principalId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The principal ID. This currently supports a Amazon Web Services SSO UserId.
", + "smithy.api#documentation": "The principal ID. This currently supports a IAM Identity Center UserId.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1580,11 +1637,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteStudioMemberResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.nimble#DeleteStudioRequest": { "type": "structure", @@ -1605,6 +1668,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#DeleteStudioResponse": { @@ -1617,6 +1683,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#DirectoryId": { @@ -1760,6 +1829,9 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "eula-acceptance" + }, "smithy.api#documentation": "Represents the acceptance of a EULA, specific to a studio" } }, @@ -1818,6 +1890,9 @@ "aws:TagKeys" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "eula" + }, "smithy.api#documentation": "Represents a EULA that is required to be accepted before the use of certain streaming images" } }, @@ -1886,6 +1961,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetEulaResponse": { @@ -1897,6 +1975,9 @@ "smithy.api#documentation": "The EULA.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetLaunchProfile": { @@ -2068,6 +2149,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetLaunchProfileDetailsResponse": { @@ -2091,6 +2175,9 @@ "smithy.api#documentation": "A collection of studio component summaries.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetLaunchProfileInitialization": { @@ -2183,6 +2270,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetLaunchProfileInitializationResponse": { @@ -2194,6 +2284,9 @@ "smithy.api#documentation": "The launch profile initialization.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetLaunchProfileMember": { @@ -2252,7 +2345,7 @@ "principalId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The principal ID. This currently supports a Amazon Web Services SSO UserId.
", + "smithy.api#documentation": "The principal ID. This currently supports a IAM Identity Center UserId.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2265,6 +2358,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetLaunchProfileMemberResponse": { @@ -2276,6 +2372,9 @@ "smithy.api#documentation": "The member.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetLaunchProfileRequest": { @@ -2297,6 +2396,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetLaunchProfileResponse": { @@ -2309,6 +2411,9 @@ "smithy.api#documentation": "The launch profile.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetStreamingImage": { @@ -2434,6 +2539,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetStreamingImageResponse": { @@ -2446,6 +2554,9 @@ "smithy.api#documentation": "The streaming image.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetStreamingSession": { @@ -2559,7 +2670,7 @@ "StreamingSessionDeleted": { "minDelay": 5, "maxDelay": 900, - "documentation": "Wait until a StreamingSessionDeleted. Use this after invoking Deletesession", + "documentation": "Wait until a StreamingSessionDeleted. Use this after invoking DeleteStreamingSession", "acceptors": [ { "state": "success", @@ -2605,6 +2716,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetStreamingSessionResponse": { @@ -2616,6 +2730,9 @@ "smithy.api#documentation": "The session.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetStreamingSessionStream": { @@ -2719,6 +2836,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetStreamingSessionStreamResponse": { @@ -2730,6 +2850,9 @@ "smithy.api#documentation": "The stream.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetStudio": { @@ -2961,6 +3084,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetStudioComponentResponse": { @@ -2973,6 +3099,9 @@ "smithy.api#documentation": "Information about the studio component.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetStudioMember": { @@ -3023,7 +3152,7 @@ "principalId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The principal ID. This currently supports a Amazon Web Services SSO UserId.
", + "smithy.api#documentation": "The principal ID. This currently supports a IAM Identity Center UserId.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3036,6 +3165,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetStudioMemberResponse": { @@ -3047,6 +3179,9 @@ "smithy.api#documentation": "The member.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#GetStudioRequest": { @@ -3060,6 +3195,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#GetStudioResponse": { @@ -3073,6 +3211,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#InternalServerErrorException": { @@ -3222,10 +3363,7 @@ "target": "com.amazonaws.nimble#ValidationResults", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The list of the latest validation results.
", - "smithy.api#tags": [ - "launch_profile_validation" - ] + "smithy.api#documentation": "The list of the latest validation results.
" } } }, @@ -3390,19 +3528,13 @@ "secureInitializationRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" } } }, @@ -3581,6 +3713,9 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "launch-profile" + }, "smithy.api#documentation": "Represents a launch profile which delegates access to a collection of studio components to studio users", "smithy.api#externalDocumentation": { "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" @@ -3698,6 +3833,14 @@ { "value": "INVALID_SUBNETS_PROVIDED", "name": "INVALID_SUBNETS_PROVIDED" + }, + { + "value": "INVALID_INSTANCE_TYPES_PROVIDED", + "name": "INVALID_INSTANCE_TYPES_PROVIDED" + }, + { + "value": "INVALID_SUBNETS_COMBINATION", + "name": "INVALID_SUBNETS_COMBINATION" } ] } @@ -3918,6 +4061,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListEulaAcceptancesResponse": { @@ -3935,6 +4081,9 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListEulas": { @@ -4001,6 +4150,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListEulasResponse": { @@ -4018,6 +4170,9 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListLaunchProfileMembers": { @@ -4082,6 +4237,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4101,6 +4257,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListLaunchProfileMembersResponse": { @@ -4118,6 +4277,9 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListLaunchProfiles": { @@ -4178,6 +4340,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4192,7 +4355,7 @@ "principalId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The principal ID. This currently supports a Amazon Web Services SSO UserId.
", + "smithy.api#documentation": "The principal ID. This currently supports a IAM Identity Center UserId.
", "smithy.api#httpQuery": "principalId" } }, @@ -4211,6 +4374,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListLaunchProfilesResponse": { @@ -4228,6 +4394,9 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListStreamingImages": { @@ -4302,6 +4471,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListStreamingImagesResponse": { @@ -4319,6 +4491,9 @@ "smithy.api#documentation": "A collection of streaming images.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListStreamingSessions": { @@ -4412,6 +4587,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListStreamingSessionsResponse": { @@ -4429,6 +4607,9 @@ "smithy.api#documentation": "A collection of streaming sessions.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListStudioComponents": { @@ -4485,6 +4666,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4518,6 +4700,9 @@ "smithy.api#httpQuery": "types" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListStudioComponentsResponse": { @@ -4535,6 +4720,9 @@ "smithy.api#documentation": "A collection of studio components.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListStudioMembers": { @@ -4591,6 +4779,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4610,6 +4799,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListStudioMembersResponse": { @@ -4627,6 +4819,9 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListStudios": { @@ -4686,6 +4881,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#ListStudiosResponse": { @@ -4704,6 +4902,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ListTagsForResource": { @@ -4761,6 +4962,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource", @@ -4804,11 +5006,15 @@ "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#MaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -4968,11 +5174,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#PutLaunchProfileMembersResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.nimble#PutStudioMembers": { "type": "operation", @@ -5051,11 +5263,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#PutStudioMembersResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.nimble#Region": { "type": "string", @@ -5266,10 +5484,7 @@ "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/start", "code": 200 }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#idempotent": {} } }, "com.amazonaws.nimble#StartStreamingSessionRequest": { @@ -5299,6 +5514,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#StartStreamingSessionResponse": { @@ -5307,6 +5525,9 @@ "session": { "target": "com.amazonaws.nimble#StreamingSession" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#StartStudioSSOConfigurationRepair": { @@ -5346,7 +5567,7 @@ "sso:CreateManagedApplicationInstance", "sso:GetManagedApplicationInstance" ], - "smithy.api#documentation": "Repairs the Amazon Web Services SSO configuration for a given studio.
\nIf the studio has a valid Amazon Web Services SSO configuration currently associated with\n it, this operation will fail with a validation error.
\nIf the studio does not have a valid Amazon Web Services SSO configuration currently\n associated with it, then a new Amazon Web Services SSO application is created for the studio\n and the studio is changed to the READY state.
\nAfter the Amazon Web Services SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
", + "smithy.api#documentation": "Repairs the IAM Identity Center configuration for a given studio.
\nIf the studio has a valid IAM Identity Center configuration currently associated with\n it, this operation will fail with a validation error.
\nIf the studio does not have a valid IAM Identity Center configuration currently\n associated with it, then a new IAM Identity Center application is created for the studio\n and the studio is changed to the READY state.
\nAfter the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-08-01/studios/{studioId}/sso-configuration", @@ -5374,6 +5595,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#StartStudioSSOConfigurationRepairResponse": { @@ -5386,6 +5610,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#StopStreamingSession": { @@ -5433,10 +5660,7 @@ "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/stop", "code": 200 }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#idempotent": {} } }, "com.amazonaws.nimble#StopStreamingSessionRequest": { @@ -5466,6 +5690,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#StopStreamingSessionResponse": { @@ -5474,6 +5701,9 @@ "session": { "target": "com.amazonaws.nimble#StreamingSession" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#StreamConfiguration": { @@ -5496,6 +5726,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
" } }, @@ -5509,19 +5740,14 @@ "maxStoppedSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
(Optional) The upload storage for a streaming session.
", - "smithy.api#tags": [ - "session_storage" - ] + "smithy.api#documentation": "(Optional) The upload storage for a streaming session.
" } } }, @@ -5549,6 +5775,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
" } }, @@ -5562,19 +5789,14 @@ "maxStoppedSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
(Optional) The upload storage for a streaming workstation that is created using this\n launch profile.
", - "smithy.api#tags": [ - "session_storage" - ] + "smithy.api#documentation": "(Optional) The upload storage for a streaming workstation that is created using this\n launch profile.
" } } }, @@ -5585,6 +5807,7 @@ "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 43200 @@ -5594,6 +5817,7 @@ "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 5760 @@ -5878,6 +6102,9 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "streaming-image" + }, "smithy.api#documentation": "Represents a streaming session machine image that can be used to launch a streaming session", "smithy.api#externalDocumentation": { "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" @@ -5986,6 +6213,34 @@ { "value": "g4dn.16xlarge", "name": "g4dn_16xlarge" + }, + { + "value": "g3.4xlarge", + "name": "g3_4xlarge" + }, + { + "value": "g3s.xlarge", + "name": "g3s_xlarge" + }, + { + "value": "g5.xlarge", + "name": "g5_xlarge" + }, + { + "value": "g5.2xlarge", + "name": "g5_2xlarge" + }, + { + "value": "g5.4xlarge", + "name": "g5_4xlarge" + }, + { + "value": "g5.8xlarge", + "name": "g5_8xlarge" + }, + { + "value": "g5.16xlarge", + "name": "g5_16xlarge" } ], "smithy.api#suppress": [ @@ -6102,46 +6357,31 @@ "stoppedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The time the session entered STOP_IN_PROGRESS state.
", - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#documentation": "The time the session entered STOP_IN_PROGRESS state.
" } }, "stoppedBy": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The user ID of the user that stopped the streaming session.
", - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#documentation": "The user ID of the user that stopped the streaming session.
" } }, "startedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The time the session entered START_IN_PROGRESS state.
", - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#documentation": "The time the session entered START_IN_PROGRESS state.
" } }, "startedBy": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The user ID of the user that started the streaming session.
", - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#documentation": "The user ID of the user that started the streaming session.
" } }, "stopAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The time the streaming session will automatically be stopped if the user doesn’t stop\n the session themselves.
", - "smithy.api#tags": [ - "stop_start_streaming_session" - ] + "smithy.api#documentation": "The time the streaming session will automatically be stopped if the user doesn’t stop\n the session themselves.
" } } }, @@ -6202,6 +6442,9 @@ "nimble:ownedBy" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "streaming-session" + }, "smithy.api#documentation": "Represents a streaming session that a studio user launches applications and connects to studio components within a studio" } }, @@ -6451,6 +6694,7 @@ "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 60, "max": 3600 @@ -6569,7 +6813,7 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO\n to enable Amazon Web Services SSO users to log in to Nimble Studio portal.
" + "smithy.api#documentation": "The IAM Identity Center application client ID used to integrate with IAM Identity Center\n to enable IAM Identity Center users to log in to Nimble Studio portal.
" } }, "state": { @@ -6642,7 +6886,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a studio resource.
\nA studio is the core resource used with Nimble Studio. You must create a studio\n first, before any other resource type can be created. All other resources you create and\n manage in Nimble Studio are contained within a studio.
\nWhen creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the\n Nimble Studio portal via Amazon Web Services SSO and your identity source.
\nThe user role must have the AmazonNimbleStudio-StudioUser managed policy attached for\n the portal to function properly.
\nThe admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached\n for the portal to function properly.
\nYour studio roles must trust the identity.nimble.amazonaws.com service principal to\n function properly.
" + "smithy.api#documentation": "Represents a studio resource.
\nA studio is the core resource used with Nimble Studio. You must create a studio\n first, before any other resource type can be created. All other resources you create and\n manage in Nimble Studio are contained within a studio.
\nWhen creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the\n Nimble Studio portal via IAM Identity Center and your identity source.
\nThe user role must have the AmazonNimbleStudio-StudioUser managed policy attached for\n the portal to function properly.
\nThe admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached\n for the portal to function properly.
\nYour studio roles must trust the identity.nimble.amazonaws.com service principal to\n function properly.
" } }, "com.amazonaws.nimble#StudioComponent": { @@ -6776,20 +7020,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" } } }, @@ -6973,6 +7211,9 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "studio-component" + }, "smithy.api#documentation": "Represents a studio component that connects a non-Nimble Studio resource in your account to your studio", "smithy.api#externalDocumentation": { "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" @@ -7314,7 +7555,7 @@ } }, "traits": { - "smithy.api#documentation": "A studio member is an association of a user from your studio identity source to\n elevated permissions that they are granted in the studio.
\nWhen you add a user to your studio using the Nimble Studio console, they are\n given access to the studio's AWS SSO application and are given access to log in to the\n Nimble Studio portal. These users have the permissions provided by the studio's\n user IAM role and do not appear in the studio membership collection. Only studio admins\n appear in studio membership.
\nWhen you add a user to studio membership with the persona ADMIN, upon logging in to\n the Nimble Studio portal, they are granted permissions specified by the Studio's\n Admin IAM role.
" + "smithy.api#documentation": "A studio member is an association of a user from your studio identity source to\n elevated permissions that they are granted in the studio.
\nWhen you add a user to your studio using the Nimble Studio console, they are\n given access to the studio's IAM Identity Center application and are given access to log in to the\n Nimble Studio portal. These users have the permissions provided by the studio's\n user IAM role and do not appear in the studio membership collection. Only studio admins\n appear in studio membership.
\nWhen you add a user to studio membership with the persona ADMIN, upon logging in to\n the Nimble Studio portal, they are granted permissions specified by the Studio's\n Admin IAM role.
" } }, "com.amazonaws.nimble#StudioMembershipList": { @@ -7406,6 +7647,9 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "studio" + }, "smithy.api#documentation": "Represents a studio that contains other Nimble Studio resources", "smithy.api#externalDocumentation": { "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" @@ -7591,6 +7835,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource", @@ -7627,7 +7872,10 @@ }, "com.amazonaws.nimble#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.nimble#Tags": { "type": "map", @@ -7736,6 +7984,7 @@ } }, "traits": { + "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource", @@ -7772,7 +8021,10 @@ }, "com.amazonaws.nimble#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.nimble#UpdateLaunchProfile": { "type": "operation", @@ -7892,7 +8144,7 @@ "principalId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The principal ID. This currently supports a Amazon Web Services SSO UserId.
", + "smithy.api#documentation": "The principal ID. This currently supports a IAM Identity Center UserId.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7905,6 +8157,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#UpdateLaunchProfileMemberResponse": { @@ -7916,6 +8171,9 @@ "smithy.api#documentation": "The updated member.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#UpdateLaunchProfileRequest": { @@ -7977,6 +8235,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#UpdateLaunchProfileResponse": { @@ -7988,6 +8249,9 @@ "smithy.api#documentation": "The launch profile.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#UpdateStreamingImage": { @@ -8071,6 +8335,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#UpdateStreamingImageResponse": { @@ -8079,6 +8346,9 @@ "streamingImage": { "target": "com.amazonaws.nimble#StreamingImage" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#UpdateStudio": { @@ -8252,22 +8522,19 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", - "smithy.api#tags": [ - "studio_component_roles" - ] + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#UpdateStudioComponentResponse": { @@ -8279,6 +8546,9 @@ "smithy.api#documentation": "Information about the studio component.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#UpdateStudioRequest": { @@ -8319,6 +8589,9 @@ "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.nimble#UpdateStudioResponse": { @@ -8331,6 +8604,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.nimble#ValidationException": { @@ -8411,6 +8687,41 @@ }, "com.amazonaws.nimble#nimble": { "type": "service", + "version": "2020-08-01", + "operations": [ + { + "target": "com.amazonaws.nimble#ListTagsForResource" + }, + { + "target": "com.amazonaws.nimble#TagResource" + }, + { + "target": "com.amazonaws.nimble#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.nimble#EulaAcceptanceResource" + }, + { + "target": "com.amazonaws.nimble#EulaResource" + }, + { + "target": "com.amazonaws.nimble#LaunchProfileResource" + }, + { + "target": "com.amazonaws.nimble#StreamingImageResource" + }, + { + "target": "com.amazonaws.nimble#StreamingSessionResource" + }, + { + "target": "com.amazonaws.nimble#StudioComponentResource" + }, + { + "target": "com.amazonaws.nimble#StudioResource" + } + ], "traits": { "aws.api#service": { "sdkId": "nimble", @@ -8487,42 +8798,7 @@ }, "smithy.api#documentation": "Welcome to the Amazon Nimble Studio API reference. This API reference provides\n methods, schema, resources, parameters, and more to help you get the most out of Nimble\n Studio.
\nNimble Studio is a virtual studio that empowers visual effects, animation, and\n interactive content teams to create content securely within a scalable, private cloud\n service.
", "smithy.api#title": "AmazonNimbleStudio" - }, - "version": "2020-08-01", - "operations": [ - { - "target": "com.amazonaws.nimble#ListTagsForResource" - }, - { - "target": "com.amazonaws.nimble#TagResource" - }, - { - "target": "com.amazonaws.nimble#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.nimble#EulaAcceptanceResource" - }, - { - "target": "com.amazonaws.nimble#EulaResource" - }, - { - "target": "com.amazonaws.nimble#LaunchProfileResource" - }, - { - "target": "com.amazonaws.nimble#StreamingImageResource" - }, - { - "target": "com.amazonaws.nimble#StreamingSessionResource" - }, - { - "target": "com.amazonaws.nimble#StudioComponentResource" - }, - { - "target": "com.amazonaws.nimble#StudioResource" - } - ] + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/polly.json b/codegen/sdk/aws-models/polly.json index b78d214f610..1a518360318 100644 --- a/codegen/sdk/aws-models/polly.json +++ b/codegen/sdk/aws-models/polly.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -131,6 +131,7 @@ "IncludeAdditionalLanguageCodes": { "target": "com.amazonaws.polly#IncludeAdditionalLanguageCodes", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value indicating whether to return any bilingual voices that\n use the specified language as an additional language. For instance, if you\n request all languages that use US English (es-US), and there is an Italian\n voice that speaks both Italian (it-IT) and US English, that voice will be\n included if you specify yes but not if you specify\n no.
Number of lexemes in the lexicon.
" } }, "Size": { "target": "com.amazonaws.polly#Size", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Total size of the lexicon, in characters.
" } } @@ -906,7 +989,6 @@ "com.amazonaws.polly#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -923,26 +1005,32 @@ } }, "com.amazonaws.polly#OutputFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "json", - "name": "JSON" - }, - { - "value": "mp3", - "name": "MP3" - }, - { - "value": "ogg_vorbis", - "name": "OGG_VORBIS" - }, - { - "value": "pcm", - "name": "PCM" - } - ] + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + }, + "MP3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mp3" + } + }, + "OGG_VORBIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ogg_vorbis" + } + }, + "PCM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pcm" + } + } } }, "com.amazonaws.polly#OutputS3BucketName": { @@ -962,24 +1050,6 @@ }, "com.amazonaws.polly#Parrot_v1": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Polly", - "arnNamespace": "polly", - "cloudFormationName": "Polly", - "cloudTrailEventSource": "polly.amazonaws.com", - "endpointPrefix": "polly" - }, - "aws.auth#sigv4": { - "name": "polly" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Polly is a web service that makes it easy to synthesize speech from\n text.
\nThe Amazon Polly service provides API operations for synthesizing\n high-quality speech from plain text and Speech Synthesis Markup Language\n (SSML), along with managing pronunciations lexicons that enable you to get\n the best results for your application domain.
", - "smithy.api#title": "Amazon Polly", - "smithy.api#xmlNamespace": { - "uri": "http://polly.amazonaws.com/doc/v1" - } - }, "version": "2016-06-10", "operations": [ { @@ -1009,7 +1079,25 @@ { "target": "com.amazonaws.polly#SynthesizeSpeech" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Polly", + "arnNamespace": "polly", + "cloudFormationName": "Polly", + "cloudTrailEventSource": "polly.amazonaws.com", + "endpointPrefix": "polly" + }, + "aws.auth#sigv4": { + "name": "polly" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Polly is a web service that makes it easy to synthesize speech from\n text.
\nThe Amazon Polly service provides API operations for synthesizing\n high-quality speech from plain text and Speech Synthesis Markup Language\n (SSML), along with managing pronunciations lexicons that enable you to get\n the best results for your application domain.
", + "smithy.api#title": "Amazon Polly", + "smithy.api#xmlNamespace": { + "uri": "http://polly.amazonaws.com/doc/v1" + } + } }, "com.amazonaws.polly#PutLexicon": { "type": "operation", @@ -1076,7 +1164,10 @@ "members": {} }, "com.amazonaws.polly#RequestCharacters": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.polly#SampleRate": { "type": "string" @@ -1095,7 +1186,10 @@ } }, "com.amazonaws.polly#Size": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.polly#SnsTopicArn": { "type": "string", @@ -1104,26 +1198,32 @@ } }, "com.amazonaws.polly#SpeechMarkType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "sentence", - "name": "SENTENCE" - }, - { - "value": "ssml", - "name": "SSML" - }, - { - "value": "viseme", - "name": "VISEME" - }, - { - "value": "word", - "name": "WORD" - } - ] + "type": "enum", + "members": { + "SENTENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sentence" + } + }, + "SSML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssml" + } + }, + "VISEME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "viseme" + } + }, + "WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "word" + } + } } }, "com.amazonaws.polly#SpeechMarkTypeList": { @@ -1340,6 +1440,7 @@ "RequestCharacters": { "target": "com.amazonaws.polly#RequestCharacters", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Number of billable characters synthesized.
" } }, @@ -1511,6 +1612,8 @@ "TextType": { "target": "com.amazonaws.polly#TextType", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "text", "smithy.api#documentation": "Specifies whether the input text is plain text or SSML. The\n default value is plain text. For more information, see Using\n SSML.
" } }, @@ -1530,7 +1633,8 @@ "target": "com.amazonaws.polly#AudioStream", "traits": { "smithy.api#documentation": "Stream containing the synthesized speech.
", - "smithy.api#httpPayload": {} + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } }, "ContentType": { @@ -1543,6 +1647,7 @@ "RequestCharacters": { "target": "com.amazonaws.polly#RequestCharacters", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Number of characters synthesized.
", "smithy.api#httpHeader": "x-amzn-RequestCharacters" } @@ -1556,26 +1661,32 @@ } }, "com.amazonaws.polly#TaskStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "scheduled", - "name": "SCHEDULED" - }, - { - "value": "inProgress", - "name": "IN_PROGRESS" - }, - { - "value": "completed", - "name": "COMPLETED" - }, - { - "value": "failed", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduled" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } } }, "com.amazonaws.polly#TaskStatusReason": { @@ -1598,18 +1709,20 @@ } }, "com.amazonaws.polly#TextType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ssml", - "name": "SSML" - }, - { - "value": "text", - "name": "TEXT" + "type": "enum", + "members": { + "SSML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssml" + } + }, + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" } - ] + } } }, "com.amazonaws.polly#UnsupportedPlsAlphabetException": { @@ -1689,298 +1802,446 @@ } }, "com.amazonaws.polly#VoiceId": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Aditi", - "name": "Aditi" - }, - { - "value": "Amy", - "name": "Amy" - }, - { - "value": "Astrid", - "name": "Astrid" - }, - { - "value": "Bianca", - "name": "Bianca" - }, - { - "value": "Brian", - "name": "Brian" - }, - { - "value": "Camila", - "name": "Camila" - }, - { - "value": "Carla", - "name": "Carla" - }, - { - "value": "Carmen", - "name": "Carmen" - }, - { - "value": "Celine", - "name": "Celine" - }, - { - "value": "Chantal", - "name": "Chantal" - }, - { - "value": "Conchita", - "name": "Conchita" - }, - { - "value": "Cristiano", - "name": "Cristiano" - }, - { - "value": "Dora", - "name": "Dora" - }, - { - "value": "Emma", - "name": "Emma" - }, - { - "value": "Enrique", - "name": "Enrique" - }, - { - "value": "Ewa", - "name": "Ewa" - }, - { - "value": "Filiz", - "name": "Filiz" - }, - { - "value": "Gabrielle", - "name": "Gabrielle" - }, - { - "value": "Geraint", - "name": "Geraint" - }, - { - "value": "Giorgio", - "name": "Giorgio" - }, - { - "value": "Gwyneth", - "name": "Gwyneth" - }, - { - "value": "Hans", - "name": "Hans" - }, - { - "value": "Ines", - "name": "Ines" - }, - { - "value": "Ivy", - "name": "Ivy" - }, - { - "value": "Jacek", - "name": "Jacek" - }, - { - "value": "Jan", - "name": "Jan" - }, - { - "value": "Joanna", - "name": "Joanna" - }, - { - "value": "Joey", - "name": "Joey" - }, - { - "value": "Justin", - "name": "Justin" - }, - { - "value": "Karl", - "name": "Karl" - }, - { - "value": "Kendra", - "name": "Kendra" - }, - { - "value": "Kevin", - "name": "Kevin" - }, - { - "value": "Kimberly", - "name": "Kimberly" - }, - { - "value": "Lea", - "name": "Lea" - }, - { - "value": "Liv", - "name": "Liv" - }, - { - "value": "Lotte", - "name": "Lotte" - }, - { - "value": "Lucia", - "name": "Lucia" - }, - { - "value": "Lupe", - "name": "Lupe" - }, - { - "value": "Mads", - "name": "Mads" - }, - { - "value": "Maja", - "name": "Maja" - }, - { - "value": "Marlene", - "name": "Marlene" - }, - { - "value": "Mathieu", - "name": "Mathieu" - }, - { - "value": "Matthew", - "name": "Matthew" - }, - { - "value": "Maxim", - "name": "Maxim" - }, - { - "value": "Mia", - "name": "Mia" - }, - { - "value": "Miguel", - "name": "Miguel" - }, - { - "value": "Mizuki", - "name": "Mizuki" - }, - { - "value": "Naja", - "name": "Naja" - }, - { - "value": "Nicole", - "name": "Nicole" - }, - { - "value": "Olivia", - "name": "Olivia" - }, - { - "value": "Penelope", - "name": "Penelope" - }, - { - "value": "Raveena", - "name": "Raveena" - }, - { - "value": "Ricardo", - "name": "Ricardo" - }, - { - "value": "Ruben", - "name": "Ruben" - }, - { - "value": "Russell", - "name": "Russell" - }, - { - "value": "Salli", - "name": "Salli" - }, - { - "value": "Seoyeon", - "name": "Seoyeon" - }, - { - "value": "Takumi", - "name": "Takumi" - }, - { - "value": "Tatyana", - "name": "Tatyana" - }, - { - "value": "Vicki", - "name": "Vicki" - }, - { - "value": "Vitoria", - "name": "Vitoria" - }, - { - "value": "Zeina", - "name": "Zeina" - }, - { - "value": "Zhiyu", - "name": "Zhiyu" - }, - { - "value": "Aria", - "name": "Aria" - }, - { - "value": "Ayanda", - "name": "Ayanda" - }, - { - "value": "Arlet", - "name": "Arlet" - }, - { - "value": "Hannah", - "name": "Hannah" - }, - { - "value": "Arthur", - "name": "Arthur" - }, - { - "value": "Daniel", - "name": "Daniel" - }, - { - "value": "Liam", - "name": "Liam" - }, - { - "value": "Pedro", - "name": "Pedro" - }, - { - "value": "Kajal", - "name": "Kajal" - } - ] + "type": "enum", + "members": { + "Aditi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Aditi" + } + }, + "Amy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Amy" + } + }, + "Astrid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Astrid" + } + }, + "Bianca": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bianca" + } + }, + "Brian": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Brian" + } + }, + "Camila": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Camila" + } + }, + "Carla": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Carla" + } + }, + "Carmen": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Carmen" + } + }, + "Celine": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Celine" + } + }, + "Chantal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Chantal" + } + }, + "Conchita": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Conchita" + } + }, + "Cristiano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cristiano" + } + }, + "Dora": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Dora" + } + }, + "Emma": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Emma" + } + }, + "Enrique": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enrique" + } + }, + "Ewa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ewa" + } + }, + "Filiz": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Filiz" + } + }, + "Gabrielle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gabrielle" + } + }, + "Geraint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Geraint" + } + }, + "Giorgio": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Giorgio" + } + }, + "Gwyneth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gwyneth" + } + }, + "Hans": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hans" + } + }, + "Ines": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ines" + } + }, + "Ivy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ivy" + } + }, + "Jacek": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Jacek" + } + }, + "Jan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Jan" + } + }, + "Joanna": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Joanna" + } + }, + "Joey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Joey" + } + }, + "Justin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Justin" + } + }, + "Karl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Karl" + } + }, + "Kendra": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kendra" + } + }, + "Kevin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kevin" + } + }, + "Kimberly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kimberly" + } + }, + "Lea": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lea" + } + }, + "Liv": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Liv" + } + }, + "Lotte": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lotte" + } + }, + "Lucia": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lucia" + } + }, + "Lupe": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lupe" + } + }, + "Mads": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Mads" + } + }, + "Maja": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maja" + } + }, + "Marlene": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Marlene" + } + }, + "Mathieu": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Mathieu" + } + }, + "Matthew": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Matthew" + } + }, + "Maxim": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maxim" + } + }, + "Mia": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Mia" + } + }, + "Miguel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Miguel" + } + }, + "Mizuki": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Mizuki" + } + }, + "Naja": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Naja" + } + }, + "Nicole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Nicole" + } + }, + "Olivia": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Olivia" + } + }, + "Penelope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Penelope" + } + }, + "Raveena": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Raveena" + } + }, + "Ricardo": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ricardo" + } + }, + "Ruben": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ruben" + } + }, + "Russell": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Russell" + } + }, + "Salli": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Salli" + } + }, + "Seoyeon": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seoyeon" + } + }, + "Takumi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Takumi" + } + }, + "Tatyana": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tatyana" + } + }, + "Vicki": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vicki" + } + }, + "Vitoria": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vitoria" + } + }, + "Zeina": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Zeina" + } + }, + "Zhiyu": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Zhiyu" + } + }, + "Aria": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Aria" + } + }, + "Ayanda": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ayanda" + } + }, + "Arlet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Arlet" + } + }, + "Hannah": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hannah" + } + }, + "Arthur": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Arthur" + } + }, + "Daniel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Daniel" + } + }, + "Liam": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Liam" + } + }, + "Pedro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pedro" + } + }, + "Kajal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kajal" + } + }, + "Hiujin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hiujin" + } + } } }, "com.amazonaws.polly#VoiceList": { diff --git a/codegen/sdk/aws-models/proton.json b/codegen/sdk/aws-models/proton.json index 1a78e09c426..c06f51da5b8 100644 --- a/codegen/sdk/aws-models/proton.json +++ b/codegen/sdk/aws-models/proton.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "shapes": { "com.amazonaws.proton#AcceptEnvironmentAccountConnection": { "type": "operation", @@ -30,7 +30,7 @@ } ], "traits": { - "smithy.api#documentation": "In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton\n can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#documentation": "In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton\n can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
\nFor more information, see Environment account\n connections in the Proton User guide.
", "smithy.api#idempotent": {} } }, @@ -93,12 +93,12 @@ "pipelineProvisioningRepository": { "target": "com.amazonaws.proton#RepositoryBranch", "traits": { - "smithy.api#documentation": "The repository configured in the Amazon Web Services account for pipeline provisioning. Required it if you have environments configured for self-managed\n provisioning with services that include pipelines.
" + "smithy.api#documentation": "The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include\n pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
" } } }, "traits": { - "smithy.api#documentation": "The Proton pipeline service role and repository data shared across the Amazon Web Services account.
" + "smithy.api#documentation": "Proton settings that are used for multiple services in the Amazon Web Services account.
" } }, "com.amazonaws.proton#AccountSettingsResource": { @@ -127,21 +127,6 @@ }, "com.amazonaws.proton#AwsProton20200720": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Proton", - "arnNamespace": "awsproton20200720", - "cloudFormationName": "AwsProton20200720", - "cloudTrailEventSource": "awsproton20200720.amazonaws.com", - "endpointPrefix": "proton" - }, - "aws.auth#sigv4": { - "name": "proton" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.
\nThe documentation for each action shows the Query API request parameters and the XML response.
\nAlternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide.
\nThe Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure\n and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to\n automate their application or service deployments.
\nBecause administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the\n listed API operations.
\nWhen developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are\n running on Proton, developers need permissions to the service create, list,\n update and delete API operations and the service instance list and\n update API operations.
\nTo learn more about Proton administration, see the Proton\n Administrator Guide.
\nTo learn more about deploying serverless and containerized applications on Proton, see the Proton User Guide.
\n\n Ensuring Idempotency\n
\nWhen you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete.\n Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might\n make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the\n operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times.\n This means that you might create more resources than you intended.
\n\n Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the\n original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the\n result might contain updated information, such as the current creation status.
\nThe following lists of APIs are grouped according to methods that ensure idempotency.
\n\n Idempotent create APIs with a client token\n
\nThe API actions in this list support idempotency with the use of a client token. The corresponding Amazon Web Services CLI commands\n also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an\n idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse\n the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided\n by SDKs.
\nGiven a request action that has succeeded:
\nIf you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other\n than returning the original resource detail data in the response.
\nIf you retry the request using the same client token, but one or more of the parameters are different, the retry throws a\n ValidationException with an IdempotentParameterMismatch error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.
\nIf the original resource is deleted and you retry the request, a new resource is created.
\nIdempotent create APIs with a client token:
\nCreateEnvironmentTemplateVersion
\nCreateServiceTemplateVersion
\nCreateEnvironmentAccountConnection
\n\n Idempotent create APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds\n without performing any further actions other than returning the original resource detail data in the response.
\nIf the original resource has been modified, the retry throws a ConflictException.
If you retry with different input parameters, the retry throws a ValidationException with an\n IdempotentParameterMismatch error.
Idempotent create APIs:
\nCreateEnvironmentTemplate
\nCreateServiceTemplate
\nCreateEnvironment
\nCreateService
\n\n Idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nWhen you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
\nIf you retry and the resource doesn't exist, the response is empty.
\nIn both cases, the retry succeeds.
\nIdempotent delete APIs:
\nDeleteEnvironmentTemplate
\nDeleteEnvironmentTemplateVersion
\nDeleteServiceTemplate
\nDeleteServiceTemplateVersion
\nDeleteEnvironmentAccountConnection
\n\n Asynchronous idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS, the\n retry returns the resource detail data in the response without performing any further actions.
If the original request delete operation is complete, a retry returns an empty response.
\nAsynchronous idempotent delete APIs:
\nDeleteEnvironment
\nDeleteService
\nThis is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.
\nThe documentation for each action shows the Query API request parameters and the XML response.
\nAlternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide.
\nThe Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure\n and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to\n automate their application or service deployments.
\nBecause administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the\n listed API operations.
\nWhen developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are\n running on Proton, developers need permissions to the service create, list,\n update and delete API operations and the service instance list and\n update API operations.
\nTo learn more about Proton, see the Proton User Guide.
\n\n Ensuring Idempotency\n
\nWhen you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete.\n Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might\n make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the\n operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times.\n This means that you might create more resources than you intended.
\n\n Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the\n original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the\n result might contain updated information, such as the current creation status.
\nThe following lists of APIs are grouped according to methods that ensure idempotency.
\n\n Idempotent create APIs with a client token\n
\nThe API actions in this list support idempotency with the use of a client token. The corresponding Amazon Web Services CLI commands\n also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an\n idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse\n the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided\n by SDKs.
\nGiven a request action that has succeeded:
\nIf you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other\n than returning the original resource detail data in the response.
\nIf you retry the request using the same client token, but one or more of the parameters are different, the retry throws a\n ValidationException with an IdempotentParameterMismatch error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.
\nIf the original resource is deleted and you retry the request, a new resource is created.
\nIdempotent create APIs with a client token:
\nCreateEnvironmentTemplateVersion
\nCreateServiceTemplateVersion
\nCreateEnvironmentAccountConnection
\n\n Idempotent create APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds\n without performing any further actions other than returning the original resource detail data in the response.
\nIf the original resource has been modified, the retry throws a ConflictException.
If you retry with different input parameters, the retry throws a ValidationException with an\n IdempotentParameterMismatch error.
Idempotent create APIs:
\nCreateEnvironmentTemplate
\nCreateServiceTemplate
\nCreateEnvironment
\nCreateService
\n\n Idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nWhen you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
\nIf you retry and the resource doesn't exist, the response is empty.
\nIn both cases, the retry succeeds.
\nIdempotent delete APIs:
\nDeleteEnvironmentTemplate
\nDeleteEnvironmentTemplateVersion
\nDeleteServiceTemplate
\nDeleteServiceTemplateVersion
\nDeleteEnvironmentAccountConnection
\n\n Asynchronous idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS, the\n retry returns the resource detail data in the response without performing any further actions.
If the original request delete operation is complete, a retry returns an empty response.
\nAsynchronous idempotent delete APIs:
\nDeleteEnvironment
\nDeleteService
\nAttempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).
For more information about components, see\n Proton components in the\n Proton User Guide.
" } }, "com.amazonaws.proton#CancelComponentDeploymentInput": { @@ -339,7 +339,7 @@ } ], "traits": { - "smithy.api#documentation": "Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more\n information, see Update an environment in the Proton\n Administrator guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more\n information, see Update an environment in the Proton\n User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS.\n For more information, see Update a service instance in the Proton Administrator guide or the Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS.\n For more information, see Update a service instance in the\n Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS.\n For more information, see Update a service pipeline in the Proton Administrator guide or the Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS.\n For more information, see Update a service pipeline in the\n Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
Detailed data of an Proton component resource.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "Detailed data of an Proton component resource.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
" } }, "com.amazonaws.proton#ComponentArn": { @@ -839,7 +839,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary data of an Proton component resource.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "Summary data of an Proton component resource.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
" } }, "com.amazonaws.proton#ComponentSummaryList": { @@ -896,7 +896,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an Proton component. A component is an infrastructure extension for a service instance.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "Create an Proton component. A component is an infrastructure extension for a service instance.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -957,7 +957,7 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } } } @@ -1006,7 +1006,7 @@ } ], "traits": { - "smithy.api#documentation": "Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be\n shared across services.
\n\n You can provision environments using the following methods:\n
\nAmazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
\nSelf-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC\n engine uses to provision resources.
\nFor more information, see Environments and Provisioning methods in the Proton Administrator\n Guide.
", + "smithy.api#documentation": "Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be\n shared across services.
\n\n You can provision environments using the following methods:\n
\nAmazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
\nSelf-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC\n engine uses to provision resources.
\nFor more information, see Environments and Provisioning methods in the Proton User\n Guide.
", "smithy.api#idempotent": {} } }, @@ -1039,7 +1039,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment\n account from a management account.
\nAn environment account connection is a secure bi-directional connection between a management account and an environment\n account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator\n guide.
", + "smithy.api#documentation": "Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment\n account from a management account.
\nAn environment account connection is a secure bi-directional connection between a management account and an environment\n account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User\n guide.
", "smithy.api#idempotent": {} } }, @@ -1077,13 +1077,13 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } }, "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nYou must specify componentRoleArn to allow directly defined components to be associated with any environments running in this\n account.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nYou must specify componentRoleArn to allow directly defined components to be associated with any environments running in this\n account.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } } @@ -1113,7 +1113,7 @@ "templateName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
", + "smithy.api#documentation": "The name of the environment template. For more information, see Environment Templates in the Proton User Guide.
", "smithy.api#required": {} } }, @@ -1139,7 +1139,7 @@ "spec": { "target": "com.amazonaws.proton#SpecContents", "traits": { - "smithy.api#documentation": "A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator\n Guide.
", + "smithy.api#documentation": "A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User\n Guide.
", "smithy.api#required": {} } }, @@ -1152,25 +1152,25 @@ "environmentAccountConnectionId": { "target": "com.amazonaws.proton#EnvironmentAccountConnectionId", "traits": { - "smithy.api#documentation": "The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment\n account. For more information, see Environment account\n connections in the Proton Administrator guide.
\nTo use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or\n protonServiceRoleArn parameter and omit the provisioningRepository parameter.
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment\n account. For more information, see Environment account\n connections in the Proton User guide.
\nTo use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or\n protonServiceRoleArn parameter and omit the provisioningRepository parameter.
An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } }, "provisioningRepository": { "target": "com.amazonaws.proton#RepositoryBranchInput", "traits": { - "smithy.api#documentation": "The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
\nTo use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and\n protonServiceRoleArn parameters.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository\n that has been registered with Proton. For more information, see CreateRepository.
\nTo use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and\n protonServiceRoleArn parameters.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nYou must specify componentRoleArn to allow directly defined components to be associated with this environment.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nYou must specify componentRoleArn to allow directly defined components to be associated with this environment.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } } @@ -1216,7 +1216,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide.
\nYou can create an environment template in one of the two following ways:
\nRegister and publish a standard environment template that instructs Proton to deploy and manage environment\n infrastructure.
\nRegister and publish a customer managed environment template that connects Proton to your existing provisioned\n infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment\n template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to\n CUSTOMER_MANAGED. For more information, see Register\n and publish an environment template in the Proton Administrator Guide.
Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide.
\nYou can create an environment template in one of the two following ways:
\nRegister and publish a standard environment template that instructs Proton to deploy and manage environment\n infrastructure.
\nRegister and publish a customer managed environment template that connects Proton to your existing provisioned\n infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment\n template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to\n CUSTOMER_MANAGED. For more information, see Register\n and publish an environment template in the Proton User Guide.
An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } } } @@ -1349,7 +1349,7 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } } } @@ -1395,7 +1395,7 @@ } ], "traits": { - "smithy.api#documentation": "Create and register a link to a repository that can be used with self-managed provisioning (infrastructure or pipelines) or for template sync\n configurations. When you create a repository link, Proton creates a service-linked role for you.
\nFor more information, see Self-managed provisioning, Template bundles, and\n Template sync configurations in the Proton\n Administrator Guide.
", + "smithy.api#documentation": "Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed\n provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed\n provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.
\nFor more information, see Self-managed provisioning, Template bundles, and\n Template sync configurations in the Proton\n User Guide.
", "smithy.api#idempotent": {} } }, @@ -1419,7 +1419,7 @@ "connectionArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator\n Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see Setting up for Proton in the Proton User\n Guide.
", "smithy.api#required": {} } }, @@ -1432,7 +1432,7 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } } } @@ -1443,7 +1443,7 @@ "repository": { "target": "com.amazonaws.proton#Repository", "traits": { - "smithy.api#documentation": "The repository detail data that's returned by Proton.
", + "smithy.api#documentation": "The repository link's detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -1481,7 +1481,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline.\n For more information, see Services in the Proton\n Administrator Guide and Services in the Proton\n User Guide.
", + "smithy.api#documentation": "Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline.\n For more information, see Services in the Proton User\n Guide.
", "smithy.api#idempotent": {} } }, @@ -1524,14 +1524,14 @@ "spec": { "target": "com.amazonaws.proton#SpecContents", "traits": { - "smithy.api#documentation": "A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format.\n Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For\n more information, see Create a service in the\n Proton Administrator Guide and Create a\n service in the Proton User Guide.
", + "smithy.api#documentation": "A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format.\n Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For\n more information, see Create a service in the Proton\n User Guide.
", "smithy.api#required": {} } }, "repositoryConnectionArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton\n Administrator Guide and Setting up with\n Proton in the Proton User Guide. Don't include this parameter if your service template\n doesn't include a service pipeline.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User\n Guide. Don't include this parameter if your service template doesn't include a service\n pipeline.
" } }, "repositoryId": { @@ -1549,7 +1549,7 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } } } @@ -1595,7 +1595,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline.\n Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a\n link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more\n information, see Service Templates in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline.\n Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a\n link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more\n information, see Proton templates in the Proton User\n Guide.
", "smithy.api#idempotent": {} } }, @@ -1630,13 +1630,13 @@ "pipelineProvisioning": { "target": "com.amazonaws.proton#Provisioning", "traits": { - "smithy.api#documentation": "By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline\n isn't provided for your service. After it's included, it can't be changed. For more information, see Service template bundles in the Proton Administrator\n Guide.
" + "smithy.api#documentation": "By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline\n isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton\n User Guide.
" } }, "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } } } @@ -1735,13 +1735,13 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + "smithy.api#documentation": "An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
" } }, "supportedComponentSources": { "target": "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceInputList", "traits": { - "smithy.api#documentation": "An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
" } } } @@ -1787,7 +1787,7 @@ } ], "traits": { - "smithy.api#documentation": "Set up a template to create new template versions automatically. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects\n a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton\n Administrator Guide.
", + "smithy.api#documentation": "Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been\n registered with Proton. For more information, see CreateRepository.
\nWhen a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle\n change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User\n Guide.
", "smithy.api#idempotent": {} } }, @@ -1818,14 +1818,14 @@ "repositoryName": { "target": "com.amazonaws.proton#RepositoryName", "traits": { - "smithy.api#documentation": "The name of your repository (for example, myrepos/myrepo).
The repository name (for example, myrepos/myrepo).
The branch of the registered repository for your template.
", + "smithy.api#documentation": "The repository branch for your template.
", "smithy.api#required": {} } }, @@ -1877,7 +1877,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete an Proton component resource.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "Delete an Proton component resource.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -1973,7 +1973,7 @@ } ], "traits": { - "smithy.api#documentation": "In an environment account, delete an environment account connection.
\nAfter you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the\n environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're\n responsible for cleaning up provisioned resources that remain without an environment connection.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#documentation": "In an environment account, delete an environment account connection.
\nAfter you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the\n environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're\n responsible for cleaning up provisioned resources that remain without an environment connection.
\nFor more information, see Environment account\n connections in the Proton User guide.
", "smithy.api#idempotent": {} } }, @@ -2223,7 +2223,7 @@ "name": { "target": "com.amazonaws.proton#RepositoryName", "traits": { - "smithy.api#documentation": "The name of the repository.
", + "smithy.api#documentation": "The repository name.
", "smithy.api#required": {} } } @@ -2242,7 +2242,7 @@ "repository": { "target": "com.amazonaws.proton#Repository", "traits": { - "smithy.api#documentation": "The repository detail data that's returned by Proton.
" + "smithy.api#documentation": "The deleted repository link's detail data that's returned by Proton.
" } } } @@ -2276,7 +2276,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete a service, with its instances and pipeline.
\nYou can't delete a service if it has any service instances that have components attached to them.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
\nDelete a service, with its instances and pipeline.
\nYou can't delete a service if it has any service instances that have components attached to them.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
\nThe infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
" + "smithy.api#documentation": "The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository\n that has been registered with Proton. For more information, see CreateRepository.
" } }, "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nThe environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nThe environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -2804,7 +2804,7 @@ "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nThe environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nThe environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -2974,7 +2974,7 @@ "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nThe environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nThe environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -3161,7 +3161,7 @@ "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nThe environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nThe environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -3624,7 +3624,7 @@ } ], "traits": { - "smithy.api#documentation": "Get detail data for the Proton pipeline service role.
", + "smithy.api#documentation": "Get detail data for Proton account-wide settings.
", "smithy.api#readonly": {} } }, @@ -3669,7 +3669,7 @@ } ], "traits": { - "smithy.api#documentation": "Get detailed data for a component.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "Get detailed data for a component.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "ComponentDeployed": { @@ -3840,7 +3840,7 @@ } ], "traits": { - "smithy.api#documentation": "In an environment account, get the detailed data for an environment account connection.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#documentation": "In an environment account, get the detailed data for an environment account connection.
\nFor more information, see Environment account\n connections in the Proton User guide.
", "smithy.api#readonly": {} } }, @@ -4034,7 +4034,7 @@ "templateName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The name of the environment template a version of which you want to get detailed data for..
", + "smithy.api#documentation": "The name of the environment template a version of which you want to get detailed data for.
", "smithy.api#required": {} } }, @@ -4099,7 +4099,7 @@ } ], "traits": { - "smithy.api#documentation": "Get detail data for a repository.
", + "smithy.api#documentation": "Get detail data for a linked repository.
", "smithy.api#readonly": {} } }, @@ -4135,7 +4135,7 @@ "repository": { "target": "com.amazonaws.proton#Repository", "traits": { - "smithy.api#documentation": "The repository detail data that's returned by Proton.
", + "smithy.api#documentation": "The repository link's detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -4167,7 +4167,7 @@ } ], "traits": { - "smithy.api#documentation": "Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
\nA repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource\n have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control\n (ABAC).
\nFor more information about ABAC, see ABAC in the Proton\n Administrator Guide.
\nGet the sync status of a repository used for Proton template sync. For more information about template sync, see .
\nA repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource\n have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control\n (ABAC).
\nFor more information about ABAC, see ABAC in the Proton User\n Guide.
\nGet a list of component Infrastructure as Code (IaC) outputs.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "Get a list of component Infrastructure as Code (IaC) outputs.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4962,7 +4962,7 @@ } ], "traits": { - "smithy.api#documentation": "List provisioned resources for a component with details.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "List provisioned resources for a component with details.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5030,7 +5030,7 @@ } ], "traits": { - "smithy.api#documentation": "List components with summary data. You can filter the result list by environment, service, or a single service instance.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
", + "smithy.api#documentation": "List components with summary data. You can filter the result list by environment, service, or a single service instance.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5116,7 +5116,7 @@ } ], "traits": { - "smithy.api#documentation": "View a list of environment account connections.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#documentation": "View a list of environment account connections.
\nFor more information, see Environment account\n connections in the Proton User guide.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5577,7 +5577,7 @@ } ], "traits": { - "smithy.api#documentation": "List repositories with detail data.
", + "smithy.api#documentation": "List linked repositories with detail data.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5616,7 +5616,7 @@ "repositories": { "target": "com.amazonaws.proton#RepositorySummaryList", "traits": { - "smithy.api#documentation": "An array of repositories.
", + "smithy.api#documentation": "An array of repository links.
", "smithy.api#required": {} } } @@ -6325,7 +6325,7 @@ } ], "traits": { - "smithy.api#documentation": "List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "smithy.api#documentation": "List tags for a resource. For more information, see Proton resources and\n tagging in the Proton User Guide.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6383,7 +6383,6 @@ "com.amazonaws.proton#MaxPageResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -6428,7 +6427,7 @@ } ], "traits": { - "smithy.api#documentation": "Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
\nFor more information, see Self-managed provisioning in the Proton Administrator Guide.
" + "smithy.api#documentation": "Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
\nFor more information, see Self-managed provisioning in the Proton User Guide.
" } }, "com.amazonaws.proton#NotifyResourceDeploymentStatusChangeInput": { @@ -6553,7 +6552,7 @@ "provisioningEngine": { "target": "com.amazonaws.proton#ProvisionedResourceEngine", "traits": { - "smithy.api#documentation": "The resource provisioning engine. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can\n be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton Administrator Guide.
" + "smithy.api#documentation": "The resource provisioning engine. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can\n be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide.
" } } }, @@ -6641,7 +6640,7 @@ } ], "traits": { - "smithy.api#documentation": "In a management account, reject an environment account connection from another environment account.
\nAfter you reject an environment account connection request, you can't accept or use the rejected environment account\n connection.
\nYou can’t reject an environment account connection that's connected to an environment.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#documentation": "In a management account, reject an environment account connection from another environment account.
\nAfter you reject an environment account connection request, you can't accept or use the rejected environment account\n connection.
\nYou can’t reject an environment account connection that's connected to an environment.
\nFor more information, see Environment account\n connections in the Proton User guide.
", "smithy.api#idempotent": {} } }, @@ -6682,7 +6681,7 @@ "arn": { "target": "com.amazonaws.proton#RepositoryArn", "traits": { - "smithy.api#documentation": "The repository Amazon Resource Name (ARN).
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the linked repository.
", "smithy.api#required": {} } }, @@ -6703,7 +6702,7 @@ "connectionArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.
", "smithy.api#required": {} } }, @@ -6715,7 +6714,7 @@ } }, "traits": { - "smithy.api#documentation": "Detailed data of a repository that has been registered with Proton.
" + "smithy.api#documentation": "Detailed data of a linked repository—a repository that has been registered with Proton.
" } }, "com.amazonaws.proton#RepositoryArn": { @@ -6732,7 +6731,7 @@ "arn": { "target": "com.amazonaws.proton#RepositoryArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository branch.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the linked repository.
", "smithy.api#required": {} } }, @@ -6759,7 +6758,7 @@ } }, "traits": { - "smithy.api#documentation": "Detail data for a repository branch.
" + "smithy.api#documentation": "Detail data for a linked repository branch.
" } }, "com.amazonaws.proton#RepositoryBranchInput": { @@ -6788,7 +6787,7 @@ } }, "traits": { - "smithy.api#documentation": "Detail input data for a repository branch.
" + "smithy.api#documentation": "Detail input data for a linked repository branch.
" } }, "com.amazonaws.proton#RepositoryId": { @@ -6867,7 +6866,7 @@ "arn": { "target": "com.amazonaws.proton#RepositoryArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for a repository.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the linked repository.
", "smithy.api#required": {} } }, @@ -6887,7 +6886,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary data of a repository that has been registered with Proton.
" + "smithy.api#documentation": "Summary data of a linked repository—a repository that has been registered with Proton.
" } }, "com.amazonaws.proton#RepositorySummaryList": { @@ -6958,7 +6957,7 @@ } }, "traits": { - "smithy.api#documentation": "The repository sync definition.
" + "smithy.api#documentation": "A repository sync definition.
" } }, "com.amazonaws.proton#RepositorySyncDefinitionList": { @@ -7380,7 +7379,7 @@ "repositoryConnectionArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton\n Administrator Guide and Setting up with\n Proton in the Proton User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User\n Guide.
" } }, "repositoryId": { @@ -7808,7 +7807,7 @@ } }, "traits": { - "smithy.api#documentation": "A quota was exceeded. For more information, see Proton Quotas in the Proton Administrator\n Guide.
", + "smithy.api#documentation": "A quota was exceeded. For more information, see Proton Quotas in\n the Proton User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -8251,7 +8250,7 @@ "supportedComponentSources": { "target": "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceInputList", "traits": { - "smithy.api#documentation": "An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -8506,7 +8505,7 @@ } ], "traits": { - "smithy.api#documentation": "Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "smithy.api#documentation": "Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -8603,7 +8602,7 @@ "repositoryName": { "target": "com.amazonaws.proton#RepositoryName", "traits": { - "smithy.api#documentation": "The name of the repository, for example myrepos/myrepo.
The repository name (for example, myrepos/myrepo).
Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
\nFor more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "smithy.api#documentation": "Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
\nFor more information, see Proton resources and tagging in the\n Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -8804,7 +8803,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the Proton service pipeline role or repository settings.
" + "smithy.api#documentation": "Update Proton settings that are used for multiple services in the Amazon Web Services account.
" } }, "com.amazonaws.proton#UpdateAccountSettingsInput": { @@ -8813,13 +8812,19 @@ "pipelineServiceRoleArn": { "target": "com.amazonaws.proton#PipelineRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by\n customer-owned automation for self-managed provisioning.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by\n customer-owned automation for self-managed provisioning.
\nTo remove a previously configured ARN, specify an empty string.
" } }, "pipelineProvisioningRepository": { "target": "com.amazonaws.proton#RepositoryBranchInput", "traits": { - "smithy.api#documentation": "A repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include\n pipelines.
" + "smithy.api#documentation": "A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include\n pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
\nTo remove a previously configured repository, set deletePipelineProvisioningRepository to true, and don't set\n pipelineProvisioningRepository.
Set to true to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured\n pipeline repository.
Update a component.
\nThere are a few modes for updating a component. The deploymentType field defines the mode.
You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is\n IN_PROGRESS.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "Update a component.
\nThere are a few modes for updating a component. The deploymentType field defines the mode.
You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is\n IN_PROGRESS.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } }, "com.amazonaws.proton#UpdateComponentInput": { @@ -8968,7 +8973,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an environment.
\nIf the environment is associated with an environment account connection, don't update or include the\n protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current\n environment account connection was created in. The account connection must also be associated with the current environment.
\nIf the environment isn't associated with an environment account connection, don't update or include the\n environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account\n connection if it isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update\n both.
If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the\n protonServiceRoleArn and environmentAccountConnectionId parameters.
For more information, see Environments and Provisioning methods in the Proton Administrator\n Guide.
\nThere are four modes for updating an environment. The deploymentType field defines the mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in\n use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template,\n by default. You can also specify a different major version that's higher than the major version in use and a minor version.
\nUpdate an environment.
\nIf the environment is associated with an environment account connection, don't update or include the\n protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current\n environment account connection was created in. The account connection must also be associated with the current environment.
\nIf the environment isn't associated with an environment account connection, don't update or include the\n environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account\n connection if it isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update\n both.
If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the\n protonServiceRoleArn and environmentAccountConnectionId parameters.
For more information, see Environments and Provisioning methods in the Proton User\n Guide.
\nThere are four modes for updating an environment. The deploymentType field defines the mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in\n use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template,\n by default. You can also specify a different major version that's higher than the major version in use and a minor version.
\nIn an environment account, update an environment account connection to use a new IAM role.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#documentation": "In an environment account, update an environment account connection to use a new IAM role.
\nFor more information, see Environment account\n connections in the Proton User guide.
", "smithy.api#idempotent": {} } }, @@ -9023,7 +9028,7 @@ "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nThe environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.
\nThe environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -9103,13 +9108,13 @@ "provisioningRepository": { "target": "com.amazonaws.proton#RepositoryBranchInput", "traits": { - "smithy.api#documentation": "The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
" + "smithy.api#documentation": "The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository\n that has been registered with Proton. For more information, see CreateRepository.
" } }, "componentRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nThe environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.
\nThe environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -9329,7 +9334,7 @@ } ], "traits": { - "smithy.api#documentation": "Edit a service description or use a spec to add and delete service instances.
\nExisting service instances and the service pipeline can't be edited using this API. They can only be deleted.
\nUse the description parameter to modify the description.
Edit the spec parameter to add or delete instances.
You can't delete a service instance (remove it from the spec) if it has an attached component.
\nFor more information about components, see\n Proton components in the\n Proton Administrator Guide.
\nEdit a service description or use a spec to add and delete service instances.
\nExisting service instances and the service pipeline can't be edited using this API. They can only be deleted.
\nUse the description parameter to modify the description.
Edit the spec parameter to add or delete instances.
You can't delete a service instance (remove it from the spec) if it has an attached component.
\nFor more information about components, see\n Proton components in the\n Proton User Guide.
\nLists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list.\n Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in\n the Proton Administrator Guide or the Proton User Guide.
" + "smithy.api#documentation": "Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list.\n Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton User Guide.
" } } }, @@ -9392,7 +9397,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a service instance.
\nThere are a few modes for updating a service instance. The deploymentType field defines the mode.
You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is\n IN_PROGRESS.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
\nUpdate a service instance.
\nThere are a few modes for updating a service instance. The deploymentType field defines the mode.
You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is\n IN_PROGRESS.
For more information about components, see\n Proton components in the\n Proton User Guide.
\nAn array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.
\nA change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A\n change only affects later associations.
For more information about components, see\n Proton components in the\n Proton Administrator Guide.
" + "smithy.api#documentation": "An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.
\nA change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A\n change only affects later associations.
For more information about components, see\n Proton components in the\n Proton User Guide.
" } } }, @@ -9767,7 +9772,7 @@ } ], "traits": { - "smithy.api#documentation": "Update template sync configuration parameters, except for the templateName and templateType.
Update template sync configuration parameters, except for the templateName and templateType. Repository details (branch,\n name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information,\n see CreateRepository.
The name of the repository (for example, myrepos/myrepo).
The repository name (for example, myrepos/myrepo).
The repository branch.
", + "smithy.api#documentation": "The repository branch for your template.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index bb9af902e05..0fe579b549a 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -55,12 +55,14 @@ "Used": { "target": "com.amazonaws.rds#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount currently used toward the quota maximum.
" } }, "Max": { "target": "com.amazonaws.rds#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum allowed value for the quota.
" } } @@ -79,18 +81,20 @@ } }, "com.amazonaws.rds#ActivityStreamMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "sync", - "name": "sync" - }, - { - "value": "async", - "name": "async" + "type": "enum", + "members": { + "sync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sync" + } + }, + "async": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "async" } - ] + } } }, "com.amazonaws.rds#ActivityStreamModeList": { @@ -100,49 +104,61 @@ } }, "com.amazonaws.rds#ActivityStreamPolicyStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "locked", - "name": "locked" - }, - { - "value": "unlocked", - "name": "unlocked" - }, - { - "value": "locking-policy", - "name": "locking_policy" - }, - { - "value": "unlocking-policy", - "name": "unlocking_policy" + "type": "enum", + "members": { + "locked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "unlocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + }, + "locking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locking-policy" + } + }, + "unlocking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocking-policy" } - ] + } } }, "com.amazonaws.rds#ActivityStreamStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "stopped", - "name": "stopped" - }, - { - "value": "starting", - "name": "starting" - }, - { - "value": "started", - "name": "started" - }, - { - "value": "stopping", - "name": "stopping" + "type": "enum", + "members": { + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "starting" } - ] + }, + "started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "started" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + } } }, "com.amazonaws.rds#AddRoleToDBCluster": { @@ -351,24 +367,6 @@ }, "com.amazonaws.rds#AmazonRDSv19": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "RDS", - "arnNamespace": "rds", - "cloudFormationName": "RDS", - "cloudTrailEventSource": "rds.amazonaws.com", - "endpointPrefix": "rds" - }, - "aws.auth#sigv4": { - "name": "rds" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n\n Amazon RDS API Reference\n
\nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nAmazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n\n Amazon RDS API Reference\n
\nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nThe maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Default: 100
\nConstraints: between 1 and 100
" + "smithy.api#documentation": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
\nConstraints: Must be between 1 and 100.
" } }, "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
Default: 50
\nConstraints: between 0 and MaxConnectionsPercent\n
Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.
" } }, "SessionPinningFilters": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. Currently, the only\n allowed value is EXCLUDE_VARIABLE_SETS.
Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. \n Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" } }, "AllocatedStorage": { @@ -2315,6 +2340,8 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 0, "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" } }, @@ -2572,7 +2599,7 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIt must be 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nIt can't end with a hyphen or contain two consecutive hyphens.
\nThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
Specifies where automated backups and manual snapshots are stored.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, @@ -3058,6 +3089,8 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 0, "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE.
A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.
The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL.
The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify \n SQLSERVER.
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.
" } }, @@ -3407,6 +3443,7 @@ "DebugLogging": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, @@ -3961,22 +3998,26 @@ } }, "com.amazonaws.rds#CustomEngineVersionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "available", - "name": "available" - }, - { - "value": "inactive", - "name": "inactive" - }, - { - "value": "inactive-except-restore", - "name": "inactive_except_restore" + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + }, + "inactive_except_restore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive-except-restore" } - ] + } } }, "com.amazonaws.rds#DBCluster": { @@ -4159,6 +4200,7 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the DB cluster is encrypted.
" } }, @@ -4345,6 +4387,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, @@ -4710,6 +4753,7 @@ "IsClusterWriter": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies the allocated storage size in gibibytes (GiB).
" } }, @@ -5074,6 +5119,7 @@ "Port": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the port that the DB cluster was listening on at the time of the snapshot.
" } }, @@ -5116,12 +5162,14 @@ "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the percentage of the estimated data that has been transferred.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the DB cluster snapshot is encrypted.
" } }, @@ -5146,6 +5194,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
" } }, @@ -5341,12 +5390,14 @@ "SupportsLogExportsToCloudwatchLogs": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
" } }, "SupportsReadReplica": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the database engine version supports read replicas.
" } }, @@ -5371,12 +5422,14 @@ "SupportsParallelQuery": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with a specific DB engine version.
" } }, @@ -5422,6 +5475,7 @@ "SupportsBabelfish": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
" } } @@ -5513,6 +5567,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the allocated storage size specified in gibibytes (GiB).
" } }, @@ -5531,6 +5586,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the number of days for which automatic DB snapshots are retained.
" } }, @@ -5585,6 +5641,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
" } }, @@ -5597,6 +5654,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
" } }, @@ -5621,6 +5679,8 @@ "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "open-read-only", "smithy.api#documentation": "The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
\nSpecifies the accessibility options for the DB instance.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, @@ -5687,6 +5748,7 @@ "DbInstancePort": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
" } }, @@ -5699,6 +5761,7 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the DB instance is encrypted.
" } }, @@ -5729,6 +5792,7 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
\nIAM database authentication can be enabled for the following database engines
\nFor MySQL 5.6, minor version 5.6.34 or higher
\nFor MySQL 5.7, minor version 5.7.16 or higher
\nAurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
\nIndicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.
" } }, @@ -5973,6 +6039,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" } }, @@ -5985,6 +6052,7 @@ "Port": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port number that the automated backup used for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
Specifies whether the automated backup is encrypted.
" } }, @@ -6075,6 +6144,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.
" } }, @@ -6337,6 +6407,7 @@ "Normal": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
" } }, @@ -6582,7 +6653,7 @@ "EngineFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. \n SQLSERVER supports RDS for Microsoft SQL Server databases.
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
" } }, "IdleClientTimeout": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.
\nDefault: 1800 (30 minutes)
\nConstraints: 1 to 28,800
" } }, "DebugLogging": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, @@ -6739,6 +6813,7 @@ "IsDefault": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.
" } } @@ -6815,49 +6890,61 @@ } }, "com.amazonaws.rds#DBProxyEndpointStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "available", - "name": "AVAILABLE" - }, - { - "value": "modifying", - "name": "MODIFYING" - }, - { - "value": "incompatible-network", - "name": "INCOMPATIBLE_NETWORK" - }, - { - "value": "insufficient-resource-limits", - "name": "INSUFFICIENT_RESOURCE_LIMITS" - }, - { - "value": "creating", - "name": "CREATING" - }, - { - "value": "deleting", - "name": "DELETING" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" } - ] + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } } }, "com.amazonaws.rds#DBProxyEndpointTargetRole": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READ_WRITE", - "name": "READ_WRITE" - }, - { - "value": "READ_ONLY", - "name": "READ_ONLY" + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" } - ] + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + } } }, "com.amazonaws.rds#DBProxyList": { @@ -6911,46 +6998,62 @@ } }, "com.amazonaws.rds#DBProxyStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "available", - "name": "AVAILABLE" - }, - { - "value": "modifying", - "name": "MODIFYING" - }, - { - "value": "incompatible-network", - "name": "INCOMPATIBLE_NETWORK" - }, - { - "value": "insufficient-resource-limits", - "name": "INSUFFICIENT_RESOURCE_LIMITS" - }, - { - "value": "creating", - "name": "CREATING" - }, - { - "value": "deleting", - "name": "DELETING" - }, - { - "value": "suspended", - "name": "SUSPENDED" - }, - { - "value": "suspending", - "name": "SUSPENDING" - }, - { - "value": "reactivating", - "name": "REACTIVATING" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspended" + } + }, + "SUSPENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspending" + } + }, + "REACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reactivating" } - ] + } } }, "com.amazonaws.rds#DBProxyTarget": { @@ -6983,6 +7086,7 @@ "Port": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
" } }, @@ -7050,6 +7154,7 @@ "IsDefault": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.
Specifies the allocated storage size in gibibytes (GiB).
" } }, @@ -7343,6 +7449,7 @@ "Port": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the port that the database engine was listening on at the time of the snapshot.
" } }, @@ -7403,6 +7510,7 @@ "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The percentage of the estimated data that has been transferred.
" } }, @@ -7433,6 +7541,7 @@ "Encrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the DB snapshot is encrypted.
" } }, @@ -7457,6 +7566,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
" } }, @@ -7924,6 +8034,7 @@ "SkipFinalSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.
\nIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
\nThis setting is required for RDS Custom.
" } }, @@ -9107,12 +9219,14 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
" } } @@ -9302,6 +9416,7 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.
" } } @@ -9370,6 +9485,7 @@ "DefaultOnly": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
" } }, @@ -9681,12 +9797,14 @@ "LastWritten": { "target": "com.amazonaws.rds#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A POSIX timestamp when the last log entry was written.
" } }, "Size": { "target": "com.amazonaws.rds#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size, in bytes, of the log file for the specified DB instance.
" } } @@ -9723,12 +9841,14 @@ "FileLastWritten": { "target": "com.amazonaws.rds#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
" } }, "FileSize": { "target": "com.amazonaws.rds#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Filters the available log files for files larger than the specified size.
" } }, @@ -10494,12 +10614,14 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
\nThis setting doesn't apply to RDS Custom.
" } }, @@ -11409,7 +11531,7 @@ "target": "com.amazonaws.rds#SourceRegionMessage" }, "traits": { - "smithy.api#documentation": "Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
", + "smithy.api#documentation": "Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.
\nUse this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.
\nTo return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.
The minimum value in the range.
" } }, "To": { "target": "com.amazonaws.rds#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum value in the range.
" } } @@ -11642,6 +11766,7 @@ "AdditionalDataPending": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that if true, indicates there is more data to be downloaded.
" } } @@ -11676,6 +11801,7 @@ "NumberOfLines": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
\nIf the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.
\nIf neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.
\nIf \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.
\nIf Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.
\nYou can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.
\nSpecifies the port that the database engine is listening on.
" } }, @@ -11778,18 +11905,26 @@ } }, "com.amazonaws.rds#EngineFamily": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MYSQL", - "name": "MYSQL" - }, - { - "value": "POSTGRESQL", - "name": "POSTGRESQL" + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" } - ] + } } }, "com.amazonaws.rds#EngineModeList": { @@ -11957,6 +12092,7 @@ "Enabled": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
" } }, @@ -12112,12 +12248,14 @@ "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The progress of the snapshot export task as a percentage.
" } }, "TotalExtractedDataInGB": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total amount of data exported, in gigabytes.
" } }, @@ -12330,22 +12468,26 @@ } }, "com.amazonaws.rds#FailoverStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "pending", - "name": "PENDING" - }, - { - "value": "failing-over", - "name": "FAILING_OVER" - }, - { - "value": "cancelling", - "name": "CANCELLING" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" } - ] + }, + "FAILING_OVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing-over" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + } } }, "com.amazonaws.rds#FeatureNameList": { @@ -12522,6 +12664,7 @@ "IsWriter": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.
" } }, @@ -12597,18 +12740,26 @@ } }, "com.amazonaws.rds#IAMAuthMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "REQUIRED", - "name": "REQUIRED" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } } }, "com.amazonaws.rds#IPRange": { @@ -12760,14 +12911,14 @@ } }, "com.amazonaws.rds#Integer": { - "type": "integer" - }, - "com.amazonaws.rds#IntegerOptional": { "type": "integer", "traits": { - "smithy.api#box": {} + "smithy.api#default": 0 } }, + "com.amazonaws.rds#IntegerOptional": { + "type": "integer" + }, "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { "type": "structure", "members": { @@ -13283,18 +13434,17 @@ } }, "com.amazonaws.rds#Long": { - "type": "long" - }, - "com.amazonaws.rds#LongOptional": { "type": "long", "traits": { - "smithy.api#box": {} + "smithy.api#default": 0 } }, + "com.amazonaws.rds#LongOptional": { + "type": "long" + }, "com.amazonaws.rds#MaxRecords": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 20, "max": 100 @@ -13495,6 +13645,8 @@ "SecondsBeforeTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 300, "smithy.api#documentation": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.
\nSpecify a value between 10 and 600 seconds.
" } }, @@ -13685,6 +13837,7 @@ "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, @@ -13763,6 +13916,7 @@ "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
Valid for: Aurora DB clusters only
" } }, @@ -13817,7 +13971,7 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" } }, "AllocatedStorage": { @@ -13847,6 +14001,8 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 0, "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" } }, @@ -14120,6 +14276,7 @@ "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.
" } }, @@ -15010,6 +15168,7 @@ "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
" } } @@ -15061,12 +15220,14 @@ "Persistent": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicate if this option is persistent.
" } }, "Permanent": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicate if this option is permanent.
" } }, @@ -15195,6 +15356,7 @@ "AllowsVpcAndNonVpcInstanceMemberships": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.
Specifies whether the option requires a port.
" } }, @@ -15338,24 +15501,28 @@ "Persistent": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
" } }, "Permanent": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
" } }, "RequiresAutoMinorEngineVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.
" } }, "VpcOnly": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If true, you can only use this option with a DB instance that is in a VPC.
" } }, @@ -15418,12 +15585,14 @@ "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value where true indicates that this option group option can be changed from the default value.
" } }, "IsRequired": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value where true indicates that a value must be specified for this option setting of the option group option.
" } }, @@ -15585,12 +15754,14 @@ "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A Boolean value that, when true, indicates the option setting can be modified from the default.
" } }, "IsCollection": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates if the option setting is part of a collection.
" } } @@ -15629,6 +15800,7 @@ "IsDefault": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if the version is the default version of the option, and otherwise false.
" } } @@ -15706,24 +15878,28 @@ "MultiAZCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance is Multi-AZ capable.
" } }, "ReadReplicaCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance can have a read replica.
" } }, "Vpc": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance is in a VPC.
" } }, "SupportsStorageEncryption": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance supports encrypted storage.
" } }, @@ -15736,24 +15912,28 @@ "SupportsIops": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance supports provisioned IOPS.
" } }, "SupportsEnhancedMonitoring": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
" } }, "SupportsIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a DB instance supports IAM database authentication.
" } }, "SupportsPerformanceInsights": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if a DB instance supports Performance Insights, otherwise false.
" } }, @@ -15820,6 +16000,7 @@ "OutpostCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether a DB instance supports RDS on Outposts.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" } }, @@ -15832,12 +16013,14 @@ "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
" } }, "SupportsClusters": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether DB instances can be configured as a Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, @@ -15943,6 +16126,7 @@ "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.
The minimum value in the range.
" } }, "To": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum value in the range.
" } }, @@ -16581,6 +16767,7 @@ "RecurringChargeAmount": { "target": "com.amazonaws.rds#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of the recurring charge.
" } }, @@ -16933,18 +17120,20 @@ } }, "com.amazonaws.rds#ReplicaMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "open-read-only", - "name": "OPEN_READ_ONLY" - }, - { - "value": "mounted", - "name": "MOUNTED" + "type": "enum", + "members": { + "OPEN_READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open-read-only" } - ] + }, + "MOUNTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mounted" + } + } } }, "com.amazonaws.rds#ReservedDBInstance": { @@ -16977,18 +17166,21 @@ "Duration": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration of the reservation in seconds.
" } }, "FixedPrice": { "target": "com.amazonaws.rds#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The fixed price charged for this reserved DB instance.
" } }, "UsagePrice": { "target": "com.amazonaws.rds#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The hourly price charged for this reserved DB instance.
" } }, @@ -17001,6 +17193,7 @@ "DBInstanceCount": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of reserved DB instances.
" } }, @@ -17019,6 +17212,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates if the reservation applies to Multi-AZ deployments.
" } }, @@ -17149,18 +17343,21 @@ "Duration": { "target": "com.amazonaws.rds#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration of the offering in seconds.
" } }, "FixedPrice": { "target": "com.amazonaws.rds#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The fixed price charged for this offering.
" } }, "UsagePrice": { "target": "com.amazonaws.rds#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The hourly price charged for this offering.
" } }, @@ -17185,6 +17382,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates if the offering applies to Multi-AZ deployments.
" } }, @@ -17278,6 +17476,7 @@ "ResetAllParameters": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.
A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.
" } }, @@ -17611,6 +17811,8 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" } }, @@ -17851,7 +18053,7 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { @@ -17994,6 +18196,7 @@ "UseLatestRestorableTime": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, @@ -18093,7 +18296,7 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { @@ -18398,6 +18601,8 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "region", "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, @@ -18886,6 +19091,7 @@ "UseLatestRestorableTime": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints: Can't be specified if the RestoreTime parameter is provided.
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, @@ -19274,6 +19482,8 @@ "SecondsBeforeTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 300, "smithy.api#documentation": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.
\nSpecify a value between 60 and 600 seconds.
" } } @@ -19450,6 +19660,7 @@ "SupportsDBInstanceAutomatedBackupsReplication": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
" } } @@ -19488,42 +19699,56 @@ } }, "com.amazonaws.rds#SourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "db-instance", - "name": "db_instance" - }, - { - "value": "db-parameter-group", - "name": "db_parameter_group" - }, - { - "value": "db-security-group", - "name": "db_security_group" - }, - { - "value": "db-snapshot", - "name": "db_snapshot" - }, - { - "value": "db-cluster", - "name": "db_cluster" - }, - { - "value": "db-cluster-snapshot", - "name": "db_cluster_snapshot" - }, - { - "value": "custom-engine-version", - "name": "custom_engine_version" - }, - { - "value": "db-proxy", - "name": "db_proxy" + "type": "enum", + "members": { + "db_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-instance" + } + }, + "db_parameter_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-parameter-group" + } + }, + "db_security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-security-group" + } + }, + "db_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-snapshot" + } + }, + "db_cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster" + } + }, + "db_cluster_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster-snapshot" + } + }, + "custom_engine_version": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom-engine-version" + } + }, + "db_proxy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-proxy" } - ] + } } }, "com.amazonaws.rds#StartActivityStream": { @@ -19626,6 +19851,7 @@ "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.
" } }, @@ -20423,30 +20649,38 @@ } }, "com.amazonaws.rds#TargetHealthReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNREACHABLE", - "name": "UNREACHABLE" - }, - { - "value": "CONNECTION_FAILED", - "name": "CONNECTION_FAILED" - }, - { - "value": "AUTH_FAILURE", - "name": "AUTH_FAILURE" - }, - { - "value": "PENDING_PROXY_CAPACITY", - "name": "PENDING_PROXY_CAPACITY" - }, - { - "value": "INVALID_REPLICATION_STATE", - "name": "INVALID_REPLICATION_STATE" + "type": "enum", + "members": { + "UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNREACHABLE" + } + }, + "CONNECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTION_FAILED" + } + }, + "AUTH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTH_FAILURE" + } + }, + "PENDING_PROXY_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_PROXY_CAPACITY" + } + }, + "INVALID_REPLICATION_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REPLICATION_STATE" } - ] + } } }, "com.amazonaws.rds#TargetList": { @@ -20456,60 +20690,72 @@ } }, "com.amazonaws.rds#TargetRole": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READ_WRITE", - "name": "READ_WRITE" - }, - { - "value": "READ_ONLY", - "name": "READ_ONLY" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" } - ] + } } }, "com.amazonaws.rds#TargetState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REGISTERING", - "name": "registering" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "UNAVAILABLE", - "name": "unavailable" + "type": "enum", + "members": { + "registering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" } - ] + } } }, "com.amazonaws.rds#TargetType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RDS_INSTANCE", - "name": "RDS_INSTANCE" - }, - { - "value": "RDS_SERVERLESS_ENDPOINT", - "name": "RDS_SERVERLESS_ENDPOINT" - }, - { - "value": "TRACKED_CLUSTER", - "name": "TRACKED_CLUSTER" + "type": "enum", + "members": { + "RDS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_INSTANCE" + } + }, + "RDS_SERVERLESS_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_SERVERLESS_ENDPOINT" } - ] + }, + "TRACKED_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACKED_CLUSTER" + } + } } }, "com.amazonaws.rds#Timezone": { @@ -20550,12 +20796,14 @@ "AutoUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
" } }, @@ -20618,7 +20866,7 @@ "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { - "smithy.api#documentation": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
" + "smithy.api#documentation": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
" + "smithy.api#documentation": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" } } @@ -20791,30 +21040,38 @@ } }, "com.amazonaws.rds#WriteForwardingStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "enabled", - "name": "ENABLED" - }, - { - "value": "disabled", - "name": "DISABLED" - }, - { - "value": "enabling", - "name": "ENABLING" - }, - { - "value": "disabling", - "name": "DISABLING" - }, - { - "value": "unknown", - "name": "UNKNOWN" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" } - ] + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } } } } diff --git a/codegen/sdk/aws-models/s3-control.json b/codegen/sdk/aws-models/s3-control.json index aa85751f70c..0b1a652914f 100644 --- a/codegen/sdk/aws-models/s3-control.json +++ b/codegen/sdk/aws-models/s3-control.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -31,24 +31,6 @@ "shapes": { "com.amazonaws.s3control#AWSS3ControlServiceV20180820": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "S3 Control", - "arnNamespace": "s3", - "cloudFormationName": "S3Control", - "cloudTrailEventSource": "s3control.amazonaws.com", - "endpointPrefix": "s3-control" - }, - "aws.auth#sigv4": { - "name": "s3" - }, - "aws.protocols#restXml": {}, - "smithy.api#documentation": "Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
", - "smithy.api#title": "AWS S3 Control", - "smithy.api#xmlNamespace": { - "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" - } - }, "version": "2018-08-20", "operations": [ { @@ -144,6 +126,9 @@ { "target": "com.amazonaws.s3control#GetBucketTagging" }, + { + "target": "com.amazonaws.s3control#GetBucketVersioning" + }, { "target": "com.amazonaws.s3control#GetJobTagging" }, @@ -201,6 +186,9 @@ { "target": "com.amazonaws.s3control#PutBucketTagging" }, + { + "target": "com.amazonaws.s3control#PutBucketVersioning" + }, { "target": "com.amazonaws.s3control#PutJobTagging" }, @@ -222,7 +210,25 @@ { "target": "com.amazonaws.s3control#UpdateJobStatus" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "S3 Control", + "arnNamespace": "s3", + "cloudFormationName": "S3Control", + "cloudTrailEventSource": "s3control.amazonaws.com", + "endpointPrefix": "s3-control" + }, + "aws.auth#sigv4": { + "name": "s3" + }, + "aws.protocols#restXml": {}, + "smithy.api#documentation": "Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
", + "smithy.api#title": "AWS S3 Control", + "smithy.api#xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + } + } }, "com.amazonaws.s3control#AbortIncompleteMultipartUpload": { "type": "structure", @@ -230,6 +236,7 @@ "DaysAfterInitiation": { "target": "com.amazonaws.s3control#DaysAfterInitiation", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to\n the Outposts bucket.
" } } @@ -340,6 +347,7 @@ "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A container for whether the activity metrics are enabled.
" } } @@ -373,7 +381,7 @@ "Message": { "target": "com.amazonaws.s3control#MaxLength1024String", "traits": { - "smithy.api#documentation": "A generic descritpion of the error condition in English.
" + "smithy.api#documentation": "A generic description of the error condition in English.
" } }, "Resource": { @@ -438,22 +446,26 @@ } }, "com.amazonaws.s3control#AsyncOperationName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CreateMultiRegionAccessPoint", - "name": "CreateMultiRegionAccessPoint" - }, - { - "value": "DeleteMultiRegionAccessPoint", - "name": "DeleteMultiRegionAccessPoint" - }, - { - "value": "PutMultiRegionAccessPointPolicy", - "name": "PutMultiRegionAccessPointPolicy" + "type": "enum", + "members": { + "CreateMultiRegionAccessPoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateMultiRegionAccessPoint" + } + }, + "DeleteMultiRegionAccessPoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteMultiRegionAccessPoint" } - ] + }, + "PutMultiRegionAccessPointPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutMultiRegionAccessPointPolicy" + } + } } }, "com.amazonaws.s3control#AsyncRequestParameters": { @@ -562,7 +574,10 @@ } }, "com.amazonaws.s3control#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.s3control#BucketAlreadyExists": { "type": "structure", @@ -581,26 +596,32 @@ } }, "com.amazonaws.s3control#BucketCannedACL": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "private", - "name": "private" - }, - { - "value": "public-read", - "name": "public_read" - }, - { - "value": "public-read-write", - "name": "public_read_write" - }, - { - "value": "authenticated-read", - "name": "authenticated_read" - } - ] + "type": "enum", + "members": { + "private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + }, + "public_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-read" + } + }, + "public_read_write": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-read-write" + } + }, + "authenticated_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authenticated-read" + } + } } }, "com.amazonaws.s3control#BucketLevel": { @@ -624,54 +645,74 @@ } }, "com.amazonaws.s3control#BucketLocationConstraint": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EU", - "name": "EU" - }, - { - "value": "eu-west-1", - "name": "eu_west_1" - }, - { - "value": "us-west-1", - "name": "us_west_1" - }, - { - "value": "us-west-2", - "name": "us_west_2" - }, - { - "value": "ap-south-1", - "name": "ap_south_1" - }, - { - "value": "ap-southeast-1", - "name": "ap_southeast_1" - }, - { - "value": "ap-southeast-2", - "name": "ap_southeast_2" - }, - { - "value": "ap-northeast-1", - "name": "ap_northeast_1" - }, - { - "value": "sa-east-1", - "name": "sa_east_1" - }, - { - "value": "cn-north-1", - "name": "cn_north_1" - }, - { - "value": "eu-central-1", - "name": "eu_central_1" - } - ] + "type": "enum", + "members": { + "EU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EU" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + } } }, "com.amazonaws.s3control#BucketName": { @@ -683,6 +724,23 @@ } } }, + "com.amazonaws.s3control#BucketVersioningStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Suspended": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suspended" + } + } + } + }, "com.amazonaws.s3control#Buckets": { "type": "list", "member": { @@ -698,6 +756,7 @@ "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A\n value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is\n enabled.
Creates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.
\n \nS3 on Outposts only supports VPC-style access points.
\nFor more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to CreateAccessPoint:
\n GetAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n ListAccessPoints\n
\nCreates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.
\n \nS3 on Outposts only supports VPC-style access points.
\nFor more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to CreateAccessPoint:
\n GetAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n ListAccessPoints\n
\nSpecifies whether you want S3 Object Lock to be enabled for the new bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe ID of the Outposts where the bucket is being created.
\nThis is required by Amazon S3 on Outposts buckets.
\nThe ID of the Outposts where the bucket is being created.
\nThis ID is required by Amazon S3 on Outposts buckets.
\nIndicates whether confirmation is required before Amazon S3 runs the job. Confirmation is\n only required for jobs created through the Amazon S3 console.
" } }, @@ -1089,7 +1155,7 @@ "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The numerical priority for this job. Higher numbers indicate higher priority.
", "smithy.api#required": {} } @@ -1222,18 +1288,27 @@ "type": "timestamp" }, "com.amazonaws.s3control#Days": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.s3control#DaysAfterInitiation": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.s3control#DeleteAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteAccessPointRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { - "smithy.api#documentation": "Deletes the specified access point.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint:
\n CreateAccessPoint\n
\n\n GetAccessPoint\n
\n\n ListAccessPoints\n
\nDeletes the specified access point.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint:
\n CreateAccessPoint\n
\n\n GetAccessPoint\n
\n\n ListAccessPoints\n
\nDeletes the specified Object Lambda Access Point.
\nThe following actions are related to\n DeleteAccessPointForObjectLambda:
Deletes the access point policy for the specified access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
\n PutAccessPointPolicy\n
\n\n GetAccessPointPolicy\n
\nDeletes the access point policy for the specified access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
\n PutAccessPointPolicy\n
\n\n GetAccessPointPolicy\n
\nRemoves the resource policy for an Object Lambda Access Point.
\nThe following actions are related to\n DeleteAccessPointPolicyForObjectLambda:
This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
\nDeletes the Amazon S3 on Outposts bucket. All objects (including all object versions and\n delete markers) in the bucket must be deleted before the bucket itself can be deleted. For\n more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
\n Related Resources\n
\n\n CreateBucket\n
\n\n GetBucket\n
\n\n DeleteObject\n
\nThis action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
\nDeletes the Amazon S3 on Outposts bucket. All objects (including all object versions and\n delete markers) in the bucket must be deleted before the bucket itself can be deleted. For\n more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n Related Resources\n
\n\n CreateBucket\n
\n\n GetBucket\n
\n\n DeleteObject\n
\nThis action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
\nDeletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket\n owner has this permission and the Outposts bucket owner can grant this permission to\n others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nThis action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
\nDeletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket\n owner has this permission and the Outposts bucket owner can grant this permission to\n others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nThis action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,\n see DeleteBucketPolicy in the Amazon S3 API Reference.
\nThis implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket\n and belong to the bucket owner's account to use this action. For more information, see\n Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy:
\n GetBucketPolicy\n
\n\n PutBucketPolicy\n
\nThis action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,\n see DeleteBucketPolicy in the Amazon S3 API Reference.
\nThis implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket\n and belong to the bucket owner's account to use this action. For more information, see\n Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy:
\n GetBucketPolicy\n
\n\n PutBucketPolicy\n
\nThis action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,\n see DeleteBucketTagging in the Amazon S3 API Reference.
\nDeletes the tags from the Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
\n\nTo use this action, you must have permission to perform the\n PutBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nThis action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,\n see DeleteBucketTagging in the Amazon S3 API Reference.
\nDeletes the tags from the Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
\n\nTo use this action, you must have permission to perform the\n PutBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nRemoves the PublicAccessBlock configuration for an Amazon Web Services account. For more\n information, see Using Amazon S3 block\n public access.
Related actions include:
\n\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nDeletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:DeleteStorageLensConfiguration action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Returns configuration information about the specified access point.
\n \n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetAccessPoint:
\n CreateAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n ListAccessPoints\n
\nReturns configuration information about the specified access point.
\n \n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetAccessPoint:
\n CreateAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n ListAccessPoints\n
\nGets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
\n PutObject\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\nGets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n PutObject\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\nThis action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3\n bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.\n
\nReturns the lifecycle configuration information set on the Outposts bucket. For more\n information, see Using Amazon S3 on Outposts and for\n information about lifecycle configuration, see Object Lifecycle\n Management in Amazon S3 User Guide.
\n\nTo use this action, you must have permission to perform the\n s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner\n has this permission, by default. The bucket owner can grant this permission to others. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
\n GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following actions are related to\n GetBucketLifecycleConfiguration:
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3\n bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.\n
\nReturns the lifecycle configuration information set on the Outposts bucket. For more\n information, see Using Amazon S3 on Outposts and for\n information about lifecycle configuration, see Object Lifecycle\n Management in Amazon S3 User Guide.
\n\nTo use this action, you must have permission to perform the\n s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner\n has this permission, by default. The bucket owner can grant this permission to others. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following actions are related to\n GetBucketLifecycleConfiguration:
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for\n an S3 bucket, see GetBucketPolicy in the\n Amazon S3 API Reference.
\nReturns the policy of a specified Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n bucket, the calling identity must have the GetBucketPolicy permissions on the\n specified bucket and belong to the bucket owner's account in order to use this\n action.
Only users from Outposts bucket owner account with the right permissions can perform\n actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy\n permissions or you're not using an identity that belongs to the bucket owner's account,\n Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetBucketPolicy:
\n GetObject\n
\n\n PutBucketPolicy\n
\n\n DeleteBucketPolicy\n
\nThis action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for\n an S3 bucket, see GetBucketPolicy in the\n Amazon S3 API Reference.
\nReturns the policy of a specified Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n bucket, the calling identity must have the GetBucketPolicy permissions on the\n specified bucket and belong to the bucket owner's account in order to use this\n action.
Only users from Outposts bucket owner account with the right permissions can perform\n actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy\n permissions or you're not using an identity that belongs to the bucket owner's account,\n Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetBucketPolicy:
\n GetObject\n
\n\n PutBucketPolicy\n
\n\n DeleteBucketPolicy\n
\nThis action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see\n GetBucketTagging in the Amazon S3 API Reference.
\nReturns the tag set associated with the Outposts bucket. For more information, see\n Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n GetBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.
\n GetBucketTagging has the following special error:
Error code: NoSuchTagSetError\n
Description: There is no tag set associated with the bucket.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetBucketTagging:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see\n GetBucketTagging in the Amazon S3 API Reference.
\nReturns the tag set associated with the Outposts bucket. For more information, see\n Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n GetBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.
\n GetBucketTagging has the following special error:
Error code: NoSuchTagSetError\n
Description: There is no tag set associated with the bucket.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetBucketTagging:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis operation returns the versioning state only for S3 on Outposts buckets. To return the versioning\n state for an S3 bucket, see GetBucketVersioning in\n the Amazon S3 API Reference.
\nReturns the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple\n distinct copies of your data and recover from unintended user actions and\n application failures.
\nIf you've never set versioning on your bucket, it has no versioning state. In that case,\n the GetBucketVersioning request does not return a versioning state\n value.
For more information about versioning, see Versioning in the Amazon S3\n User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to GetBucketVersioning for S3 on Outposts.
\n PutBucketVersioning\n
\nThe Amazon Web Services account ID of the S3 on Outposts bucket.
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "The S3 on Outposts bucket to return the versioning state for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3control#GetBucketVersioningResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3control#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "The versioning state of the S3 on Outposts bucket.
" + } + }, + "MFADelete": { + "target": "com.amazonaws.s3control#MFADeleteStatus", + "traits": { + "smithy.api#documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is returned only if the bucket has been configured with MFA delete. If MFA delete\n has never been configured for the bucket, this element is not returned.
", + "smithy.api#xmlName": "MfaDelete" + } + } + } + }, "com.amazonaws.s3control#GetJobTagging": { "type": "operation", "input": { @@ -3165,10 +3335,16 @@ } }, "com.amazonaws.s3control#IsEnabled": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.s3control#IsPublic": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.s3control#JobArn": { "type": "string", @@ -3195,7 +3371,7 @@ "ConfirmationRequired": { "target": "com.amazonaws.s3control#ConfirmationRequired", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates whether confirmation is required before Amazon S3 begins running the specified job.\n Confirmation is required only for jobs created through the Amazon S3 console.
" } }, @@ -3232,6 +3408,7 @@ "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The priority of the specified job.
" } }, @@ -3384,6 +3561,7 @@ "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The current priority for the specified job.
" } }, @@ -3451,41 +3629,49 @@ } }, "com.amazonaws.s3control#JobManifestFieldName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ignore", - "name": "Ignore" - }, - { - "value": "Bucket", - "name": "Bucket" - }, - { - "value": "Key", - "name": "Key" - }, - { - "value": "VersionId", - "name": "VersionId" - } - ] + "type": "enum", + "members": { + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ignore" + } + }, + "Bucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bucket" + } + }, + "Key": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Key" + } + }, + "VersionId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VersionId" + } + } } }, "com.amazonaws.s3control#JobManifestFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "S3BatchOperations_CSV_20180820", - "name": "S3BatchOperations_CSV_20180820" - }, - { - "value": "S3InventoryReport_CSV_20161130", - "name": "S3InventoryReport_CSV_20161130" + "type": "enum", + "members": { + "S3BatchOperations_CSV_20180820": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3BatchOperations_CSV_20180820" + } + }, + "S3InventoryReport_CSV_20161130": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3InventoryReport_CSV_20161130" } - ] + } } }, "com.amazonaws.s3control#JobManifestGenerator": { @@ -3508,7 +3694,7 @@ "EligibleForReplication": { "target": "com.amazonaws.s3control#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Include objects in the generated manifest only if they are eligible for replication\n according to the Replication configuration on the source bucket.
" } }, @@ -3587,6 +3773,7 @@ "com.amazonaws.s3control#JobNumberOfTasksFailed": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -3595,6 +3782,7 @@ "com.amazonaws.s3control#JobNumberOfTasksSucceeded": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -3659,6 +3847,7 @@ "com.amazonaws.s3control#JobPriority": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 2147483647 @@ -3671,21 +3860,21 @@ "TotalNumberOfTasks": { "target": "com.amazonaws.s3control#JobTotalNumberOfTasks", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "" } }, "NumberOfTasksSucceeded": { "target": "com.amazonaws.s3control#JobNumberOfTasksSucceeded", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "" } }, "NumberOfTasksFailed": { "target": "com.amazonaws.s3control#JobNumberOfTasksFailed", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "" } }, @@ -3718,6 +3907,7 @@ "Enabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the specified job will generate a job-completion report.
", "smithy.api#required": {} } @@ -3740,88 +3930,114 @@ } }, "com.amazonaws.s3control#JobReportFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Report_CSV_20180820", - "name": "Report_CSV_20180820" + "type": "enum", + "members": { + "Report_CSV_20180820": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Report_CSV_20180820" } - ] + } } }, "com.amazonaws.s3control#JobReportScope": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AllTasks", - "name": "AllTasks" - }, - { - "value": "FailedTasksOnly", - "name": "FailedTasksOnly" + "type": "enum", + "members": { + "AllTasks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllTasks" } - ] + }, + "FailedTasksOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FailedTasksOnly" + } + } } }, "com.amazonaws.s3control#JobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "Active" - }, - { - "value": "Cancelled", - "name": "Cancelled" - }, - { - "value": "Cancelling", - "name": "Cancelling" - }, - { - "value": "Complete", - "name": "Complete" - }, - { - "value": "Completing", - "name": "Completing" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Failing", - "name": "Failing" - }, - { - "value": "New", - "name": "New" - }, - { - "value": "Paused", - "name": "Paused" - }, - { - "value": "Pausing", - "name": "Pausing" - }, - { - "value": "Preparing", - "name": "Preparing" - }, - { - "value": "Ready", - "name": "Ready" - }, - { - "value": "Suspended", - "name": "Suspended" - } - ] + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "Cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelling" + } + }, + "Complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + }, + "Completing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completing" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failing" + } + }, + "New": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "New" + } + }, + "Paused": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Paused" + } + }, + "Pausing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pausing" + } + }, + "Preparing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Preparing" + } + }, + "Ready": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ready" + } + }, + "Suspended": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suspended" + } + } } }, "com.amazonaws.s3control#JobStatusException": { @@ -3857,6 +4073,7 @@ "com.amazonaws.s3control#JobTimeInStateSeconds": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -3868,7 +4085,7 @@ "ElapsedTimeInActiveSeconds": { "target": "com.amazonaws.s3control#JobTimeInStateSeconds", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates the elapsed time in seconds the job has been in the Active job state.
" } } @@ -3880,6 +4097,7 @@ "com.amazonaws.s3control#JobTotalNumberOfTasks": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -3934,12 +4152,14 @@ "Days": { "target": "com.amazonaws.s3control#Days", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.
" } }, "ExpiredObjectDeleteMarker": { "target": "com.amazonaws.s3control#ExpiredObjectDeleteMarker", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired. If set to false, the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
" } } @@ -4066,7 +4286,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsResult" }, "traits": { - "smithy.api#documentation": "Returns a list of the access points currently associated with the specified bucket. You can\n retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or\n the number specified in maxResults, whichever is less), the response will\n include a continuation token that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
\n CreateAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n GetAccessPoint\n
\nReturns a list of the access points currently associated with the specified bucket. You can\n retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or\n the number specified in maxResults, whichever is less), the response will\n include a continuation token that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
\n CreateAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n GetAccessPoint\n
\nThe maximum number of access points that you want to include in the list. The response may\n contain fewer access points but will never contain more. If there are more than this number of\n access points, then the response will include a continuation token in the NextToken\n field that you can use to retrieve the next page of access points.
The maximum number of access points that you want to include in the list. If the specified\n bucket has more than this number of access points, then the response will include a continuation\n token in the NextToken field that you can use to retrieve the next page of\n access points.
The maximum number of jobs that Amazon S3 will include in the List Jobs\n response. If there are more jobs than this number, the response will include a pagination\n token in the NextToken field to enable you to retrieve the next page of\n results.
Not currently used. Do not use this parameter.
", "smithy.api#httpQuery": "maxResults" } @@ -4411,6 +4635,7 @@ "MaxResults": { "target": "com.amazonaws.s3control#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "", "smithy.api#httpQuery": "maxResults" } @@ -4418,7 +4643,7 @@ "OutpostId": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { - "smithy.api#documentation": "The ID of the Outposts.
\nThis is required by Amazon S3 on Outposts buckets.
\nThe ID of the Outposts resource.
\nThis ID is required by Amazon S3 on Outposts buckets.
\nA container for whether the S3 Storage Lens configuration is enabled. This property is\n required.
" } } @@ -4542,6 +4768,43 @@ "com.amazonaws.s3control#Location": { "type": "string" }, + "com.amazonaws.s3control#MFA": { + "type": "string" + }, + "com.amazonaws.s3control#MFADelete": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3control#MFADeleteStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, "com.amazonaws.s3control#ManifestPrefixString": { "type": "string", "traits": { @@ -4563,6 +4826,7 @@ "com.amazonaws.s3control#MaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1000 @@ -4572,6 +4836,7 @@ "com.amazonaws.s3control#MinStorageBytesPercentage": { "type": "double", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0.1, "max": 100 @@ -4684,7 +4949,7 @@ "Status": { "target": "com.amazonaws.s3control#MultiRegionAccessPointStatus", "traits": { - "smithy.api#documentation": "The current status of the Multi-Region Access Point.
\n\n CREATING and DELETING are temporary states that exist while\n the request is propogating and being completed. If a Multi-Region Access Point has a status of\n PARTIALLY_CREATED, you can retry creation or send a request to delete the\n Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete\n request to finish the deletion of the Multi-Region Access Point.
The current status of the Multi-Region Access Point.
\n\n CREATING and DELETING are temporary states that exist while\n the request is propagating and being completed. If a Multi-Region Access Point has a status of\n PARTIALLY_CREATED, you can retry creation or send a request to delete the\n Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete\n request to finish the deletion of the Multi-Region Access Point.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.
" } } @@ -4839,6 +5117,7 @@ "NoncurrentDays": { "target": "com.amazonaws.s3control#Days", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon S3 User Guide.
" } }, @@ -4928,18 +5207,20 @@ } }, "com.amazonaws.s3control#ObjectLambdaAllowedFeature": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GetObject-Range", - "name": "GetObjectRange" - }, - { - "value": "GetObject-PartNumber", - "name": "GetObjectPartNumber" + "type": "enum", + "members": { + "GetObjectRange": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetObject-Range" } - ] + }, + "GetObjectPartNumber": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetObject-PartNumber" + } + } } }, "com.amazonaws.s3control#ObjectLambdaAllowedFeaturesList": { @@ -4964,6 +5245,7 @@ "CloudWatchMetricsEnabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A container for whether the CloudWatch metrics configuration is enabled.
" } }, @@ -5035,14 +5317,14 @@ } }, "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GetObject", - "name": "GetObject" + "type": "enum", + "members": { + "GetObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetObject" } - ] + } } }, "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationActionsList": { @@ -5064,60 +5346,79 @@ } }, "com.amazonaws.s3control#ObjectLockEnabledForBucket": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.s3control#OperationName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LambdaInvoke", - "name": "LambdaInvoke" - }, - { - "value": "S3PutObjectCopy", - "name": "S3PutObjectCopy" - }, - { - "value": "S3PutObjectAcl", - "name": "S3PutObjectAcl" - }, - { - "value": "S3PutObjectTagging", - "name": "S3PutObjectTagging" - }, - { - "value": "S3DeleteObjectTagging", - "name": "S3DeleteObjectTagging" - }, - { - "value": "S3InitiateRestoreObject", - "name": "S3InitiateRestoreObject" - }, - { - "value": "S3PutObjectLegalHold", - "name": "S3PutObjectLegalHold" - }, - { - "value": "S3PutObjectRetention", - "name": "S3PutObjectRetention" - }, - { - "value": "S3ReplicateObject", - "name": "S3ReplicateObject" - } - ] + "type": "enum", + "members": { + "LambdaInvoke": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaInvoke" + } + }, + "S3PutObjectCopy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3PutObjectCopy" + } + }, + "S3PutObjectAcl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3PutObjectAcl" + } + }, + "S3PutObjectTagging": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3PutObjectTagging" + } + }, + "S3DeleteObjectTagging": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3DeleteObjectTagging" + } + }, + "S3InitiateRestoreObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3InitiateRestoreObject" + } + }, + "S3PutObjectLegalHold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3PutObjectLegalHold" + } + }, + "S3PutObjectRetention": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3PutObjectRetention" + } + }, + "S3ReplicateObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3ReplicateObject" + } + } } }, "com.amazonaws.s3control#OutputSchemaVersion": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "V_1", - "name": "V_1" + "type": "enum", + "members": { + "V_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V_1" } - ] + } } }, "com.amazonaws.s3control#Policy": { @@ -5129,6 +5430,7 @@ "IsPublic": { "target": "com.amazonaws.s3control#IsPublic", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "", "smithy.api#xmlName": "IsPublic" } @@ -5162,6 +5464,7 @@ "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A container for whether prefix-level storage metrics are enabled.
" } }, @@ -5193,6 +5496,7 @@ "BlockPublicAcls": { "target": "com.amazonaws.s3control#Setting", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets\n in this account. Setting this element to TRUE causes the following\n behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is\n public.
\nPUT Object calls fail if the request includes a public ACL.
\nPUT Bucket calls fail if the request includes a public ACL.
\nEnabling this setting doesn't affect existing policies or ACLs.
\nThis is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "BlockPublicAcls" } @@ -5200,6 +5504,7 @@ "IgnorePublicAcls": { "target": "com.amazonaws.s3control#Setting", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting\n this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in\n this account and any objects that they contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.
\nThis is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "IgnorePublicAcls" } @@ -5207,6 +5512,7 @@ "BlockPublicPolicy": { "target": "com.amazonaws.s3control#Setting", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account.\n Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket\n policy if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
\nThis is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "BlockPublicPolicy" } @@ -5214,6 +5520,7 @@ "RestrictPublicBuckets": { "target": "com.amazonaws.s3control#Setting", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this\n account. Setting this element to TRUE restricts access to buckets with public\n policies to only Amazon Web Service principals and authorized users within this\n account.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
\nThis is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "RestrictPublicBuckets" } @@ -5224,13 +5531,19 @@ } }, "com.amazonaws.s3control#PublicAccessBlockEnabled": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.s3control#PutAccessPointConfigurationForObjectLambda": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutAccessPointConfigurationForObjectLambdaRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "Replaces configuration for an Object Lambda Access Point.
\nThe following actions are related to\n PutAccessPointConfigurationForObjectLambda:
Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy:
\n GetAccessPointPolicy\n
\nAssociates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy:
\n GetAccessPointPolicy\n
\nCreates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.
\nThe following actions are related to\n PutAccessPointPolicyForObjectLambda:
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a\n lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.\n
\nCreates a new lifecycle configuration for the S3 on Outposts bucket or replaces an\n existing lifecycle configuration. Outposts buckets only support lifecycle configurations\n that delete/expire objects after a certain period of time and abort incomplete multipart\n uploads.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to\n PutBucketLifecycleConfiguration:
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a\n lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.\n
\nCreates a new lifecycle configuration for the S3 on Outposts bucket or replaces an\n existing lifecycle configuration. Outposts buckets only support lifecycle configurations\n that delete/expire objects after a certain period of time and abort incomplete multipart\n uploads.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to\n PutBucketLifecycleConfiguration:
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an\n S3 bucket, see PutBucketPolicy in the\n Amazon S3 API Reference.
\nApplies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the PutBucketPolicy\n permissions on the specified Outposts bucket and belong to the bucket owner's account in\n order to use this action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketPolicy:
\n GetBucketPolicy\n
\n\n DeleteBucketPolicy\n
\nThis action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an\n S3 bucket, see PutBucketPolicy in the\n Amazon S3 API Reference.
\nApplies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the PutBucketPolicy\n permissions on the specified Outposts bucket and belong to the bucket owner's account in\n order to use this action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketPolicy:
\n GetBucketPolicy\n
\n\n DeleteBucketPolicy\n
\nSet this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThis action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see\n PutBucketTagging in the Amazon S3 API Reference.
\nSets the tags for an S3 on Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost allocation and\n tagging.
\n\nWithin a bucket, if you add a tag that has the same key as an existing tag, the new\n value overwrites the old value. For more information, see Using cost allocation in Amazon S3\n bucket tags.
\nTo use this action, you must have permissions to perform the\n s3-outposts:PutBucketTagging action. The Outposts bucket owner has this\n permission by default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n access permissions to your Amazon S3 resources.
\n PutBucketTagging has the following special errors:
Error code: InvalidTagError\n
Description: The tag provided was not a valid tag. This error can occur if\n the tag did not pass input validation. For information about tag restrictions,\n see \n User-Defined Tag Restrictions and \n Amazon Web Services-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError \n
Description: A conflicting conditional action is currently in progress\n against this resource. Try again.
\nError code: InternalError\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketTagging:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see\n PutBucketTagging in the Amazon S3 API Reference.
\nSets the tags for an S3 on Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost allocation and\n tagging.
\n\nWithin a bucket, if you add a tag that has the same key as an existing tag, the new\n value overwrites the old value. For more information, see Using cost allocation in Amazon S3\n bucket tags.
\nTo use this action, you must have permissions to perform the\n s3-outposts:PutBucketTagging action. The Outposts bucket owner has this\n permission by default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n access permissions to your Amazon S3 resources.
\n PutBucketTagging has the following special errors:
Error code: InvalidTagError\n
Description: The tag provided was not a valid tag. This error can occur if\n the tag did not pass input validation. For information about tag restrictions,\n see \n User-Defined Tag Restrictions and \n Amazon Web Services-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError \n
Description: A conflicting conditional action is currently in progress\n against this resource. Try again.
\nError code: InternalError\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketTagging:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis operation sets the versioning state only for S3 on Outposts buckets. To set the\n versioning state for an S3 bucket, see PutBucketVersioning in\n the Amazon S3 API Reference.
\nSets the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple\n distinct copies of your data and recover from unintended user actions and\n application failures.
\nYou can set the versioning state to one of the following:
\n\n Enabled - Enables versioning for the objects in the bucket. \n All objects added to the bucket receive a unique version ID.
\n\n Suspended - Suspends versioning for the objects\n in the bucket. All objects added to the bucket receive the version ID\n null.
If you've never set versioning on your bucket, it has no versioning state. In that\n case, a \n GetBucketVersioning request does not return a versioning state value.
\nWhen you enable S3 Versioning, for each object in your bucket, you have a current\n version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle\n rules to expire noncurrent versions after a specified time period. For more information,\n see Creating and managing\n a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3\n User Guide.
\nIf you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same \n permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. \n The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions \n in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to PutBucketVersioning for S3 on Outposts.
\n GetBucketVersioning\n
\nThe Amazon Web Services account ID of the S3 on Outposts bucket.
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "The S3 on Outposts bucket to set the versioning state for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MFA": { + "target": "com.amazonaws.s3control#MFA", + "traits": { + "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device.
", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "VersioningConfiguration": { + "target": "com.amazonaws.s3control#VersioningConfiguration", + "traits": { + "smithy.api#documentation": "The root-level tag for the VersioningConfiguration parameters.
Creates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. For this operation, users must have the\n s3:PutBucketPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.
Related actions include:
\n\n GetPublicAccessBlock\n
\nCreates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. For this operation, users must have the\n s3:PutAccountPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.
Related actions include:
\n\n GetPublicAccessBlock\n
\nPuts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with\n Amazon S3 Storage Lens in the Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect\n bucket-level settings for S3 Bucket Key.
" } }, @@ -6294,6 +6718,7 @@ "com.amazonaws.s3control#S3ExpirationInDays": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -6317,18 +6742,20 @@ } }, "com.amazonaws.s3control#S3GlacierJobTier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BULK", - "name": "BULK" - }, - { - "value": "STANDARD", - "name": "STANDARD" + "type": "enum", + "members": { + "BULK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BULK" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" } - ] + } } }, "com.amazonaws.s3control#S3Grant": { @@ -6384,22 +6811,26 @@ } }, "com.amazonaws.s3control#S3GranteeTypeIdentifier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "id", - "name": "CANONICAL" - }, - { - "value": "emailAddress", - "name": "EMAIL_ADDRESS" - }, - { - "value": "uri", - "name": "GROUP" + "type": "enum", + "members": { + "CANONICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "id" } - ] + }, + "EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "emailAddress" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uri" + } + } } }, "com.amazonaws.s3control#S3InitiateRestoreObjectOperation": { @@ -6408,7 +6839,7 @@ "ExpirationInDays": { "target": "com.amazonaws.s3control#S3ExpirationInDays", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains\n available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive\n objects require ExpirationInDays set to 1 or greater.
Conversely, do not set ExpirationInDays when creating\n S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and\n Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are\n not subject to restore expiry, so specifying ExpirationInDays results in\n restore request failure.
S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class\n objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier\n objects, but not both types in the same job. If you need to restore objects of both types\n you must create separate Batch Operations jobs.
" } }, @@ -6454,6 +6885,7 @@ "EnableManifestOutput": { "target": "com.amazonaws.s3control#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Determines whether or not to write the job's generated manifest to a bucket.
", "smithy.api#required": {} } @@ -6514,18 +6946,20 @@ } }, "com.amazonaws.s3control#S3MetadataDirective": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COPY", - "name": "COPY" - }, - { - "value": "REPLACE", - "name": "REPLACE" + "type": "enum", + "members": { + "COPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY" + } + }, + "REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE" } - ] + } } }, "com.amazonaws.s3control#S3ObjectLockLegalHold": { @@ -6544,48 +6978,54 @@ } }, "com.amazonaws.s3control#S3ObjectLockLegalHoldStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OFF", - "name": "OFF" - }, - { - "value": "ON", - "name": "ON" + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + }, + "ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON" } - ] + } } }, "com.amazonaws.s3control#S3ObjectLockMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPLIANCE", - "name": "COMPLIANCE" - }, - { - "value": "GOVERNANCE", - "name": "GOVERNANCE" + "type": "enum", + "members": { + "COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIANCE" } - ] + }, + "GOVERNANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOVERNANCE" + } + } } }, "com.amazonaws.s3control#S3ObjectLockRetentionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPLIANCE", - "name": "COMPLIANCE" - }, - { - "value": "GOVERNANCE", - "name": "GOVERNANCE" + "type": "enum", + "members": { + "COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIANCE" } - ] + }, + "GOVERNANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOVERNANCE" + } + } } }, "com.amazonaws.s3control#S3ObjectMetadata": { @@ -6624,7 +7064,7 @@ "ContentLength": { "target": "com.amazonaws.s3control#S3ContentLength", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "" } }, @@ -6649,6 +7089,7 @@ "RequesterCharged": { "target": "com.amazonaws.s3control#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "" } }, @@ -6693,30 +7134,38 @@ } }, "com.amazonaws.s3control#S3Permission": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FULL_CONTROL", - "name": "FULL_CONTROL" - }, - { - "value": "READ", - "name": "READ" - }, - { - "value": "WRITE", - "name": "WRITE" - }, - { - "value": "READ_ACP", - "name": "READ_ACP" - }, - { - "value": "WRITE_ACP", - "name": "WRITE_ACP" - } - ] + "type": "enum", + "members": { + "FULL_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_CONTROL" + } + }, + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE" + } + }, + "READ_ACP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ACP" + } + }, + "WRITE_ACP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE_ACP" + } + } } }, "com.amazonaws.s3control#S3RegionalBucketArn": { @@ -6756,18 +7205,20 @@ } }, "com.amazonaws.s3control#S3SSEAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AES256", - "name": "AES256" - }, - { - "value": "KMS", - "name": "KMS" + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" } - ] + } } }, "com.amazonaws.s3control#S3SetObjectAclOperation": { @@ -6805,7 +7256,7 @@ "BypassGovernanceRetention": { "target": "com.amazonaws.s3control#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates if the action should be applied to objects in the Batch Operations job even if they\n have Object Lock GOVERNANCE type in place.
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed\n key to use for encrypting generated manifest objects.
", + "smithy.api#documentation": "Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed\n key to use for encrypting generated manifest objects.
", "smithy.api#required": {} } } @@ -6976,12 +7439,14 @@ "MaxDepth": { "target": "com.amazonaws.s3control#StorageLensPrefixLevelMaxDepth", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The max depth of the selection criteria
" } }, "MinStorageBytesPercentage": { "target": "com.amazonaws.s3control#MinStorageBytesPercentage", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The minimum number of storage bytes percentage whose metrics will be selected.
\nYou must choose a value greater than or equal to 1.0.
A container for whether the S3 Storage Lens configuration is enabled.
", "smithy.api#required": {} } @@ -7140,6 +7609,7 @@ "com.amazonaws.s3control#StorageLensPrefixLevelMaxDepth": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 10 @@ -7273,6 +7743,7 @@ "Days": { "target": "com.amazonaws.s3control#Days", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.
" } }, @@ -7297,30 +7768,38 @@ } }, "com.amazonaws.s3control#TransitionStorageClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GLACIER", - "name": "GLACIER" - }, - { - "value": "STANDARD_IA", - "name": "STANDARD_IA" - }, - { - "value": "ONEZONE_IA", - "name": "ONEZONE_IA" - }, - { - "value": "INTELLIGENT_TIERING", - "name": "INTELLIGENT_TIERING" - }, - { - "value": "DEEP_ARCHIVE", - "name": "DEEP_ARCHIVE" - } - ] + "type": "enum", + "members": { + "GLACIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER" + } + }, + "STANDARD_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_IA" + } + }, + "ONEZONE_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONEZONE_IA" + } + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTELLIGENT_TIERING" + } + }, + "DEEP_ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE" + } + } } }, "com.amazonaws.s3control#UpdateJobPriority": { @@ -7380,6 +7859,7 @@ "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The priority you want to assign to this job.
", "smithy.api#httpQuery": "priority", "smithy.api#required": {} @@ -7400,6 +7880,7 @@ "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The new priority assigned to the specified job.
", "smithy.api#required": {} } @@ -7503,6 +7984,27 @@ } } }, + "com.amazonaws.s3control#VersioningConfiguration": { + "type": "structure", + "members": { + "MFADelete": { + "target": "com.amazonaws.s3control#MFADelete", + "traits": { + "smithy.api#documentation": "Specifies whether MFA delete is enabled or disabled in the bucket versioning configuration\n for the S3 on Outposts bucket.
", + "smithy.api#xmlName": "MfaDelete" + } + }, + "Status": { + "target": "com.amazonaws.s3control#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "Sets the versioning state of the S3 on Outposts bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see\n PutBucketVersioning.
" + } + }, "com.amazonaws.s3control#VpcConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 3801d88fd52..0c2ad0570b6 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -83,34 +83,44 @@ } }, "com.amazonaws.sagemaker#ActionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Unknown", - "name": "UNKNOWN" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" } - ] + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#ActionSummaries": { @@ -362,6 +372,7 @@ "AgentCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of Edge Manager agents.
", "smithy.api#required": {} } @@ -434,18 +445,20 @@ } }, "com.amazonaws.sagemaker#AlgorithmSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" } - ] + } } }, "com.amazonaws.sagemaker#AlgorithmSpecification": { @@ -478,6 +491,7 @@ "EnableSageMakerMetricsTimeSeries": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:
You use one of the SageMaker built-in algorithms
\nYou use one of the following Prebuilt SageMaker Docker Images:
\nTensorflow (version >= 1.15)
\nMXNet (version >= 1.6)
\nPyTorch (version >= 1.3)
\nYou specify at least one MetricDefinition\n
\nThe compression used for Athena query results.
", - "smithy.api#enum": [ - { - "value": "GZIP", - "name": "GZIP" - }, - { - "value": "SNAPPY", - "name": "SNAPPY" - }, - { - "value": "ZLIB", - "name": "ZLIB" + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" } - ] + }, + "ZLIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZLIB" + } + } + }, + "traits": { + "smithy.api#documentation": "The compression used for Athena query results.
" } }, "com.amazonaws.sagemaker#AthenaResultFormat": { - "type": "string", - "traits": { - "smithy.api#documentation": "The data storage format for Athena query results.
", - "smithy.api#enum": [ - { - "value": "PARQUET", - "name": "PARQUET" - }, - { - "value": "ORC", - "name": "ORC" - }, - { - "value": "AVRO", - "name": "AVRO" - }, - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "TEXTFILE", - "name": "TEXTFILE" + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" } - ] + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORC" + } + }, + "AVRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVRO" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "TEXTFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTFILE" + } + } + }, + "traits": { + "smithy.api#documentation": "The data storage format for Athena query results.
" } }, "com.amazonaws.sagemaker#AthenaWorkGroup": { @@ -1780,22 +1971,27 @@ } }, "com.amazonaws.sagemaker#AuthMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SSO", - "name": "SSO" - }, - { - "value": "IAM", - "name": "IAM" + "type": "enum", + "members": { + "SSO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" } - ] + } } }, "com.amazonaws.sagemaker#AutoGenerateEndpointName": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#AutoMLCandidate": { "type": "structure", @@ -1880,7 +2076,7 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input data source to\n run an Autopilot job (optional). This file should be in json format as shown below:
\n\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] is case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
A URL to the Amazon S3 data source containing selected features from the input data source to\n run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON\n format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot will only support the following data types:\n numeric, categorical, text and\n datetime. In HPO mode, Autopilot can support numeric,\n categorical, text, datetime and\n sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] is case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
Whether to use traffic encryption between the container layers.
" } }, @@ -2617,37 +2899,43 @@ } }, "com.amazonaws.sagemaker#AutoMLSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "Status", - "name": "STATUS" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" } - ] + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } } }, "com.amazonaws.sagemaker#AutoMLSortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "ASCENDING" - }, - { - "value": "Descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" } - ] + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } } }, "com.amazonaws.sagemaker#AutoRollbackConfig": { @@ -2665,18 +2953,20 @@ } }, "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS/Rekognition/DetectModerationLabels/Image/V3", - "name": "REKOGNITION_DETECT_MODERATION_LABELS_IMAGE_V3" - }, - { - "value": "AWS/Textract/AnalyzeDocument/Forms/V1", - "name": "TEXTRACT_ANALYZE_DOCUMENT_FORMS_V1" + "type": "enum", + "members": { + "REKOGNITION_DETECT_MODERATION_LABELS_IMAGE_V3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS/Rekognition/DetectModerationLabels/Image/V3" } - ] + }, + "TEXTRACT_ANALYZE_DOCUMENT_FORMS_V1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS/Textract/AnalyzeDocument/Forms/V1" + } + } } }, "com.amazonaws.sagemaker#BatchDescribeModelPackage": { @@ -2812,18 +3102,20 @@ } }, "com.amazonaws.sagemaker#BatchStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MultiRecord", - "name": "MULTI_RECORD" - }, - { - "value": "SingleRecord", - "name": "SINGLE_RECORD" + "type": "enum", + "members": { + "MULTI_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultiRecord" } - ] + }, + "SINGLE_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleRecord" + } + } } }, "com.amazonaws.sagemaker#Bias": { @@ -2855,7 +3147,6 @@ "com.amazonaws.sagemaker#BillableTimeInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -2898,21 +3189,26 @@ } }, "com.amazonaws.sagemaker#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#BooleanOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "And", - "name": "AND" - }, - { - "value": "Or", - "name": "OR" + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "And" } - ] + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Or" + } + } } }, "com.amazonaws.sagemaker#Branch": { @@ -3044,49 +3340,61 @@ } }, "com.amazonaws.sagemaker#CandidateSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CreationTime", - "name": "CreationTime" - }, - { - "value": "Status", - "name": "Status" - }, - { - "value": "FinalObjectiveMetricValue", - "name": "FinalObjectiveMetricValue" + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" } - ] + }, + "FinalObjectiveMetricValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FinalObjectiveMetricValue" + } + } } }, "com.amazonaws.sagemaker#CandidateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopped", - "name": "STOPPED" - }, - { - "value": "Stopping", - "name": "STOPPING" + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + } } }, "com.amazonaws.sagemaker#CandidateStepArn": { @@ -3109,22 +3417,26 @@ } }, "com.amazonaws.sagemaker#CandidateStepType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS::SageMaker::TrainingJob", - "name": "TRAINING" - }, - { - "value": "AWS::SageMaker::TransformJob", - "name": "TRANSFORM" - }, - { - "value": "AWS::SageMaker::ProcessingJob", - "name": "PROCESSING" + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::TrainingJob" + } + }, + "TRANSFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::TransformJob" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::ProcessingJob" } - ] + } } }, "com.amazonaws.sagemaker#CandidateSteps": { @@ -3133,6 +3445,20 @@ "target": "com.amazonaws.sagemaker#AutoMLCandidateStep" } }, + "com.amazonaws.sagemaker#CanvasAppSettings": { + "type": "structure", + "members": { + "TimeSeriesForecastingSettings": { + "target": "com.amazonaws.sagemaker#TimeSeriesForecastingSettings", + "traits": { + "smithy.api#documentation": "Time series forecast settings for the Canvas app.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The SageMaker Canvas app settings.
" + } + }, "com.amazonaws.sagemaker#CapacitySize": { "type": "structure", "members": { @@ -3156,24 +3482,25 @@ } }, "com.amazonaws.sagemaker#CapacitySizeType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INSTANCE_COUNT", - "name": "INSTANCE_COUNT" - }, - { - "value": "CAPACITY_PERCENT", - "name": "CAPACITY_PERCENT" + "type": "enum", + "members": { + "INSTANCE_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_COUNT" + } + }, + "CAPACITY_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPACITY_PERCENT" } - ] + } } }, "com.amazonaws.sagemaker#CapacitySizeValue": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -3200,18 +3527,20 @@ } }, "com.amazonaws.sagemaker#CaptureMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Input", - "name": "INPUT" - }, - { - "value": "Output", - "name": "OUTPUT" + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" } - ] + } } }, "com.amazonaws.sagemaker#CaptureOption": { @@ -3242,18 +3571,20 @@ } }, "com.amazonaws.sagemaker#CaptureStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Started", - "name": "STARTED" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" } - ] + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#Catalog": { @@ -3364,6 +3695,7 @@ "com.amazonaws.sagemaker#Cents": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 99 @@ -3371,7 +3703,10 @@ } }, "com.amazonaws.sagemaker#CertifyForMarketplace": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#Channel": { "type": "structure", @@ -3454,6 +3789,7 @@ "IsRequired": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the channel is required by the algorithm.
" } }, @@ -3573,12 +3909,14 @@ "SkipCheck": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.
Whether to certify the algorithm so that it can be listed in Amazon Web Services\n Marketplace.
" } }, @@ -4869,6 +5232,7 @@ "GenerateCandidateDefinitionsOnly": { "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Generates possible candidates without training the models. A candidate is a combination\n of data preprocessors, algorithms, and algorithm parameter settings.
" } }, @@ -6641,6 +7005,7 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" } } @@ -6773,6 +7138,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to certify the model package for listing on Amazon Web Services Marketplace.
\nThis parameter is optional for unversioned models, and does not apply to versioned\n models.
" } }, @@ -7641,7 +8007,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
You must not include any security-sensitive information, such as \n account access IDs, secrets, and tokens, in the dictionary for configuring \n hyperparameters. SageMaker rejects the training job request and returns an \n exception error for detected credentials, if such user input is found.
\n\n InputDataConfig - Describes the training dataset and the Amazon S3,\n EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" + "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
You must not include any security-sensitive information, such as account\n access IDs, secrets, and tokens, in the dictionary for configuring\n hyperparameters. SageMaker rejects the training job request and returns an\n exception error for detected credentials, if such user input is\n found.
\n\n InputDataConfig - Describes the training dataset and the Amazon S3,\n EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" } }, "com.amazonaws.sagemaker#CreateTrainingJobRequest": { @@ -7657,7 +8023,7 @@ "HyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
You must not include any security-sensitive information, such as \n account access IDs, secrets, and tokens, in the dictionary for configuring \n hyperparameters. SageMaker rejects the training job request and returns an \n exception error for detected credentials, if such user input is found.
\nAlgorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
You must not include any security-sensitive information, such as account access\n IDs, secrets, and tokens, in the dictionary for configuring hyperparameters. SageMaker\n rejects the training job request and returns an exception error for detected\n credentials, if such user input is found.
\nIsolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" } }, "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.
To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.
" } }, @@ -8080,7 +8449,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an\n administrator invites a person by email or imports them from Amazon Web Services SSO, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n
" + "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n
" } }, "com.amazonaws.sagemaker#CreateUserProfileRequest": { @@ -8103,13 +8472,13 @@ "SingleSignOnUserIdentifier": { "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", "traits": { - "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\".\n If the Domain's AuthMode is Amazon Web Services SSO, this field is required. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.\n
" + "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\".\n If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" } }, "SingleSignOnUserValue": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is Amazon Web Services SSO, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.\n
" + "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" } }, "Tags": { @@ -8313,7 +8682,6 @@ "ImageVersionNumber": { "target": "com.amazonaws.sagemaker#ImageVersionNumber", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The version number of the CustomImage.
" } }, @@ -8388,6 +8756,7 @@ "EnableCapture": { "target": "com.amazonaws.sagemaker#EnableCapture", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether data capture should be enabled or disabled (defaults to enabled).
" } }, @@ -8435,6 +8804,7 @@ "EnableCapture": { "target": "com.amazonaws.sagemaker#EnableCapture", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether data capture is enabled or disabled.
", "smithy.api#required": {} } @@ -8502,18 +8872,20 @@ } }, "com.amazonaws.sagemaker#DataDistributionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FullyReplicated", - "name": "FULLYREPLICATED" - }, - { - "value": "ShardedByS3Key", - "name": "SHARDEDBYS3KEY" + "type": "enum", + "members": { + "FULLYREPLICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyReplicated" + } + }, + "SHARDEDBYS3KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShardedByS3Key" } - ] + } } }, "com.amazonaws.sagemaker#DataExplorationNotebookLocation": { @@ -8772,6 +9144,7 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the processing instance.
" } }, @@ -8851,6 +9224,7 @@ "com.amazonaws.sagemaker#DefaultGid": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 65535 @@ -8860,6 +9234,7 @@ "com.amazonaws.sagemaker#DefaultUid": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 65535 @@ -9249,7 +9624,7 @@ } ], "traits": { - "smithy.api#documentation": "Used to delete a domain.\n If you onboarded with IAM mode, you will need to delete your domain to onboard again using Amazon Web Services SSO.\n Use with caution. All of the members of the domain will lose access to their EFS volume,\n including data, notebooks, and other artifacts.\n
" + "smithy.api#documentation": "Used to delete a domain.\n If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center.\n Use with caution. All of the members of the domain will lose access to their EFS volume,\n including data, notebooks, and other artifacts.\n
" } }, "com.amazonaws.sagemaker#DeleteDomainRequest": { @@ -10196,6 +10571,7 @@ "Success": { "target": "com.amazonaws.sagemaker#Success", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Returns true if the work team was successfully deleted; otherwise,\n returns false.
Whether the algorithm is certified to be listed in Amazon Web Services\n Marketplace.
" } } @@ -10990,6 +11368,7 @@ "GenerateCandidateDefinitionsOnly": { "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the output for an AutoML job generates candidate definitions\n only.
" } }, @@ -11612,6 +11991,7 @@ "MaxModels": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of models.
" } }, @@ -11688,7 +12068,7 @@ "SingleSignOnManagedApplicationInstanceId": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The Amazon Web Services SSO managed application instance ID.
" + "smithy.api#documentation": "The IAM Identity Center managed application instance ID.
" } }, "Status": { @@ -11822,6 +12202,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#DeploymentStageMaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to select (50 by default).
" } } @@ -11861,18 +12242,21 @@ "EdgeDeploymentSuccess": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices with the successful deployment.
" } }, "EdgeDeploymentPending": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices yet to pick up deployment, or in progress.
" } }, "EdgeDeploymentFailed": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices that failed the deployment.
" } }, @@ -13870,6 +14254,7 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If True, no inbound or outbound network calls can be made to or from the\n model container.
Whether the model package is certified for listing on Amazon Web Services Marketplace.
" } }, @@ -15514,18 +15900,21 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
The environment variables to set in the Docker container.
" } + }, + "WarmPoolStatus": { + "target": "com.amazonaws.sagemaker#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "The status of the warm pool associated with the training job.
" + } } } }, @@ -16115,13 +16510,13 @@ "SingleSignOnUserIdentifier": { "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", "traits": { - "smithy.api#documentation": "The Amazon Web Services SSO user identifier.
" + "smithy.api#documentation": "The IAM Identity Center user identifier.
" } }, "SingleSignOnUserValue": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The Amazon Web Services SSO user value.
" + "smithy.api#documentation": "The IAM Identity Center user value.
" } }, "UserSettings": { @@ -16262,49 +16657,61 @@ } }, "com.amazonaws.sagemaker#DetailedAlgorithmStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NotStarted", - "name": "NOT_STARTED" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.sagemaker#DetailedModelPackageStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NotStarted", - "name": "NOT_STARTED" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" } - ] + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.sagemaker#Device": { @@ -16345,34 +16752,44 @@ } }, "com.amazonaws.sagemaker#DeviceDeploymentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READYTODEPLOY", - "name": "ReadyToDeploy" - }, - { - "value": "INPROGRESS", - "name": "InProgress" - }, - { - "value": "DEPLOYED", - "name": "Deployed" - }, - { - "value": "FAILED", - "name": "Failed" - }, - { - "value": "STOPPING", - "name": "Stopping" - }, - { - "value": "STOPPED", - "name": "Stopped" + "type": "enum", + "members": { + "ReadyToDeploy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READYTODEPLOY" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Deployed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.sagemaker#DeviceDeploymentSummaries": { @@ -16555,6 +16972,7 @@ "Percentage": { "target": "com.amazonaws.sagemaker#Percentage", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Percentage of devices in the fleet to deploy to the current stage.
" } }, @@ -16581,6 +16999,7 @@ "ConnectedDeviceCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of devices connected with a heartbeat.
", "smithy.api#required": {} } @@ -16588,6 +17007,7 @@ "RegisteredDeviceCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of registered devices.
", "smithy.api#required": {} } @@ -16598,22 +17018,26 @@ } }, "com.amazonaws.sagemaker#DeviceSubsetType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PERCENTAGE", - "name": "Percentage" - }, - { - "value": "SELECTION", - "name": "Selection" - }, - { - "value": "NAMECONTAINS", - "name": "NameContains" + "type": "enum", + "members": { + "Percentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" } - ] + }, + "Selection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTION" + } + }, + "NameContains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMECONTAINS" + } + } } }, "com.amazonaws.sagemaker#DeviceSummaries": { @@ -16693,37 +17117,43 @@ } }, "com.amazonaws.sagemaker#DirectInternetAccess": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled", - "name": "ENABLED" - }, - { - "value": "Disabled", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" } - ] + } } }, "com.amazonaws.sagemaker#Direction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Both", - "name": "BOTH" - }, - { - "value": "Ascendants", - "name": "ASCENDANTS" - }, - { - "value": "Descendants", - "name": "DESCENDANTS" + "type": "enum", + "members": { + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Both" + } + }, + "ASCENDANTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascendants" + } + }, + "DESCENDANTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descendants" } - ] + } } }, "com.amazonaws.sagemaker#DirectoryPath": { @@ -16737,7 +17167,10 @@ } }, "com.amazonaws.sagemaker#DisableProfiler": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolio": { "type": "operation", @@ -16760,16 +17193,28 @@ "members": {} }, "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#DisassociateTrialComponent": { "type": "operation", @@ -16827,6 +17272,7 @@ "com.amazonaws.sagemaker#Dollars": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 2 @@ -16948,7 +17394,7 @@ "ExecutionRoleIdentityConfig": { "target": "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig", "traits": { - "smithy.api#documentation": "The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
" + "smithy.api#documentation": "The configuration for attaching a SageMaker user profile name to the execution role as a\n sts:SourceIdentity key.
" } } }, @@ -16968,7 +17414,7 @@ "ExecutionRoleIdentityConfig": { "target": "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig", "traits": { - "smithy.api#documentation": "The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.
The configuration for attaching a SageMaker user profile name to the execution role as a\n sts:SourceIdentity key. This configuration can only be modified if there\n are no apps in the InService or Pending state.
The number of edge devices with the successful deployment.
", "smithy.api#required": {} } @@ -17286,6 +17742,7 @@ "EdgeDeploymentPending": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices yet to pick up the deployment, or in progress.
", "smithy.api#required": {} } @@ -17293,6 +17750,7 @@ "EdgeDeploymentFailed": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices that failed the deployment.
", "smithy.api#required": {} } @@ -17327,6 +17785,7 @@ "EdgeDeploymentSuccessInStage": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices with the successful deployment in the current stage.
", "smithy.api#required": {} } @@ -17334,6 +17793,7 @@ "EdgeDeploymentPendingInStage": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices yet to pick up the deployment in current stage, or in progress.
", "smithy.api#required": {} } @@ -17341,6 +17801,7 @@ "EdgeDeploymentFailedInStage": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of edge devices that failed the deployment in current stage.
", "smithy.api#required": {} } @@ -17416,6 +17877,7 @@ "OfflineDeviceCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of devices that have this model version and do not have a heart beat.
", "smithy.api#required": {} } @@ -17423,6 +17885,7 @@ "ConnectedDeviceCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of devices that have this model version and have a heart beat.
", "smithy.api#required": {} } @@ -17430,6 +17893,7 @@ "ActiveDeviceCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of devices that have this model version, a heart beat, and are currently running.
", "smithy.api#required": {} } @@ -17437,6 +17901,7 @@ "SamplingDeviceCount": { "target": "com.amazonaws.sagemaker#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of devices with this model version and are producing sample data.
", "smithy.api#required": {} } @@ -17530,34 +17995,44 @@ } }, "com.amazonaws.sagemaker#EdgePackagingJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "Starting" - }, - { - "value": "INPROGRESS", - "name": "InProgress" - }, - { - "value": "COMPLETED", - "name": "Completed" - }, - { - "value": "FAILED", - "name": "Failed" - }, - { - "value": "STOPPING", - "name": "Stopping" - }, - { - "value": "STOPPED", - "name": "Stopped" + "type": "enum", + "members": { + "Starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" } - ] + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.sagemaker#EdgePackagingJobSummaries": { @@ -17668,29 +18143,31 @@ } }, "com.amazonaws.sagemaker#EdgePresetDeploymentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPLETED", - "name": "Completed" - }, - { - "value": "FAILED", - "name": "Failed" + "type": "enum", + "members": { + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" } - ] + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.sagemaker#EdgePresetDeploymentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GreengrassV2Component", - "name": "GreengrassV2Component" + "type": "enum", + "members": { + "GreengrassV2Component": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreengrassV2Component" } - ] + } } }, "com.amazonaws.sagemaker#EdgeVersion": { @@ -17720,14 +18197,14 @@ } }, "com.amazonaws.sagemaker#EnableCapture": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#EnableIotRoleAlias": { "type": "boolean", "traits": { - "smithy.api#box": {} + "smithy.api#default": false } }, + "com.amazonaws.sagemaker#EnableIotRoleAlias": { + "type": "boolean" + }, "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolio": { "type": "operation", "input": { @@ -17866,18 +18343,20 @@ } }, "com.amazonaws.sagemaker#EndpointConfigSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "CreationTime", - "name": "CreationTime" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } } }, "com.amazonaws.sagemaker#EndpointConfigSummary": { @@ -18071,6 +18550,7 @@ "InitialInstanceCount": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of instances recommended to launch initially.
", "smithy.api#required": {} } @@ -18081,61 +18561,79 @@ } }, "com.amazonaws.sagemaker#EndpointSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "CreationTime", - "name": "CreationTime" - }, - { - "value": "Status", - "name": "Status" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" } - ] + } } }, "com.amazonaws.sagemaker#EndpointStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OutOfService", - "name": "OUT_OF_SERVICE" - }, - { - "value": "Creating", - "name": "CREATING" - }, - { - "value": "Updating", - "name": "UPDATING" - }, - { - "value": "SystemUpdating", - "name": "SYSTEM_UPDATING" - }, - { - "value": "RollingBack", - "name": "ROLLING_BACK" - }, - { - "value": "InService", - "name": "IN_SERVICE" - }, - { - "value": "Deleting", - "name": "DELETING" - }, - { - "value": "Failed", - "name": "FAILED" + "type": "enum", + "members": { + "OUT_OF_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OutOfService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" } - ] + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "ROLLING_BACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.sagemaker#EndpointSummary": { @@ -18298,53 +18796,67 @@ } }, "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USER_PROFILE_NAME", - "name": "USER_PROFILE_NAME" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "USER_PROFILE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PROFILE_NAME" } - ] + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, "com.amazonaws.sagemaker#ExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "CompletedWithViolations", - "name": "COMPLETED_WITH_VIOLATIONS" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" } - ] + }, + "COMPLETED_WITH_VIOLATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithViolations" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#ExitMessage": { @@ -18566,7 +19078,6 @@ "com.amazonaws.sagemaker#ExpiresInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 300 @@ -18610,18 +19121,20 @@ } }, "com.amazonaws.sagemaker#FailureHandlingPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ROLLBACK_ON_FAILURE", - "name": "RollbackOnFailure" - }, - { - "value": "DO_NOTHING", - "name": "DoNothing" + "type": "enum", + "members": { + "RollbackOnFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_ON_FAILURE" } - ] + }, + "DoNothing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOTHING" + } + } } }, "com.amazonaws.sagemaker#FailureReason": { @@ -18795,7 +19308,6 @@ "com.amazonaws.sagemaker#FeatureGroupMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -18822,68 +19334,84 @@ } }, "com.amazonaws.sagemaker#FeatureGroupSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "FeatureGroupStatus", - "name": "FEATURE_GROUP_STATUS" - }, - { - "value": "OfflineStoreStatus", - "name": "OFFLINE_STORE_STATUS" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "FEATURE_GROUP_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureGroupStatus" + } + }, + "OFFLINE_STORE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OfflineStoreStatus" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } } }, "com.amazonaws.sagemaker#FeatureGroupSortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "ASCENDING" - }, - { - "value": "Descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" } - ] + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } } }, "com.amazonaws.sagemaker#FeatureGroupStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Creating", - "name": "CREATING" - }, - { - "value": "Created", - "name": "CREATED" - }, - { - "value": "CreateFailed", - "name": "CREATE_FAILED" - }, - { - "value": "Deleting", - "name": "DELETING" - }, - { - "value": "DeleteFailed", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" } - ] + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } } }, "com.amazonaws.sagemaker#FeatureGroupSummaries": { @@ -19075,23 +19603,44 @@ } } }, + "com.amazonaws.sagemaker#FeatureStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.sagemaker#FeatureType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Integral", - "name": "INTEGRAL" - }, - { - "value": "Fractional", - "name": "FRACTIONAL" - }, - { - "value": "String", - "name": "STRING" + "type": "enum", + "members": { + "INTEGRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Integral" + } + }, + "FRACTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Fractional" } - ] + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + } } }, "com.amazonaws.sagemaker#FileSource": { @@ -19122,18 +19671,20 @@ } }, "com.amazonaws.sagemaker#FileSystemAccessMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "rw", - "name": "RW" - }, - { - "value": "ro", - "name": "RO" + "type": "enum", + "members": { + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rw" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ro" } - ] + } } }, "com.amazonaws.sagemaker#FileSystemConfig": { @@ -19148,14 +19699,14 @@ "DefaultUid": { "target": "com.amazonaws.sagemaker#DefaultUid", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The default POSIX user ID (UID). If not specified, defaults to 1000.
The default POSIX group ID (GID). If not specified, defaults to 100.
The value of the metric with the best result.
", "smithy.api#required": {} } @@ -19320,6 +19874,7 @@ "Value": { "target": "com.amazonaws.sagemaker#MetricValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The value of the objective metric.
", "smithy.api#required": {} } @@ -19342,7 +19897,10 @@ } }, "com.amazonaws.sagemaker#Float": { - "type": "float" + "type": "float", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.sagemaker#FlowDefinitionArn": { "type": "string", @@ -19386,26 +19944,32 @@ } }, "com.amazonaws.sagemaker#FlowDefinitionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Initializing", - "name": "INITIALIZING" - }, - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Deleting", - "name": "DELETING" + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" } - ] + } } }, "com.amazonaws.sagemaker#FlowDefinitionSummaries": { @@ -19459,7 +20023,6 @@ "com.amazonaws.sagemaker#FlowDefinitionTaskAvailabilityLifetimeInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 864000 @@ -19469,7 +20032,6 @@ "com.amazonaws.sagemaker#FlowDefinitionTaskCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 3 @@ -19511,7 +20073,6 @@ "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 30, "max": 28800 @@ -19529,46 +20090,62 @@ } }, "com.amazonaws.sagemaker#Framework": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TENSORFLOW", - "name": "TENSORFLOW" - }, - { - "value": "KERAS", - "name": "KERAS" - }, - { - "value": "MXNET", - "name": "MXNET" - }, - { - "value": "ONNX", - "name": "ONNX" - }, - { - "value": "PYTORCH", - "name": "PYTORCH" - }, - { - "value": "XGBOOST", - "name": "XGBOOST" - }, - { - "value": "TFLITE", - "name": "TFLITE" - }, - { - "value": "DARKNET", - "name": "DARKNET" - }, - { - "value": "SKLEARN", - "name": "SKLEARN" + "type": "enum", + "members": { + "TENSORFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TENSORFLOW" } - ] + }, + "KERAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KERAS" + } + }, + "MXNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MXNET" + } + }, + "ONNX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONNX" + } + }, + "PYTORCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTORCH" + } + }, + "XGBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XGBOOST" + } + }, + "TFLITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TFLITE" + } + }, + "DARKNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DARKNET" + } + }, + "SKLEARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKLEARN" + } + } } }, "com.amazonaws.sagemaker#FrameworkVersion": { @@ -19582,7 +20159,10 @@ } }, "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sagemaker#GetDeviceFleetReport": { "type": "operation", @@ -20115,18 +20695,20 @@ } }, "com.amazonaws.sagemaker#HumanTaskUiStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "Deleting", - "name": "DELETING" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" } - ] + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } } }, "com.amazonaws.sagemaker#HumanTaskUiSummaries": { @@ -20207,26 +20789,32 @@ } }, "com.amazonaws.sagemaker#HyperParameterScalingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Auto", - "name": "AUTO" - }, - { - "value": "Linear", - "name": "LINEAR" - }, - { - "value": "Logarithmic", - "name": "LOGARITHMIC" - }, - { - "value": "ReverseLogarithmic", - "name": "REVERSE_LOGARITHMIC" + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linear" + } + }, + "LOGARITHMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Logarithmic" + } + }, + "REVERSE_LOGARITHMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReverseLogarithmic" } - ] + } } }, "com.amazonaws.sagemaker#HyperParameterSpecification": { @@ -20261,12 +20849,14 @@ "IsTunable": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether this hyperparameter is tunable in a hyperparameter tuning\n job.
" } }, "IsRequired": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether this hyperparameter is required.
" } }, @@ -20363,18 +20953,21 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" } }, "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See SageMaker distributed training\n jobs for more information.
The volume size in GB of the data to be processed for hyperparameter optimization\n (optional).
", "smithy.api#required": {} } @@ -20658,18 +21253,20 @@ } }, "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Maximize", - "name": "MAXIMIZE" - }, - { - "value": "Minimize", - "name": "MINIMIZE" + "type": "enum", + "members": { + "MAXIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximize" } - ] + }, + "MINIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimize" + } + } } }, "com.amazonaws.sagemaker#HyperParameterTuningJobObjectives": { @@ -20758,53 +21355,65 @@ } }, "traits": { - "smithy.api#documentation": "An entity having characteristics over which a user can search for a hyperparameter\n tuning job.
" + "smithy.api#documentation": "An entity returned by the SearchRecord API\n containing the properties of a hyperparameter tuning job.
" } }, "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "Status", - "name": "Status" - }, - { - "value": "CreationTime", - "name": "CreationTime" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" } - ] + } } }, "com.amazonaws.sagemaker#HyperParameterTuningJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopped", - "name": "STOPPED" - }, - { - "value": "Stopping", - "name": "STOPPING" + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" } - ] + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + } } }, "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig": { @@ -20822,23 +21431,29 @@ } }, "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The strategy hyperparameter tuning uses to\n find\n the best combination of hyperparameters for your model. Currently,\n the only\n supported\n value is Bayesian.
The strategy hyperparameter tuning uses to\n find\n the best combination of hyperparameters for your model. Currently,\n the only\n supported\n value is Bayesian.
The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.
SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.
\nSpecifies the number of instances of the instance group.
", "smithy.api#required": {} } @@ -21868,290 +22519,429 @@ } }, "com.amazonaws.sagemaker#InstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ml.t2.medium", - "name": "ML_T2_MEDIUM" - }, - { - "value": "ml.t2.large", - "name": "ML_T2_LARGE" - }, - { - "value": "ml.t2.xlarge", - "name": "ML_T2_XLARGE" - }, - { - "value": "ml.t2.2xlarge", - "name": "ML_T2_2XLARGE" - }, - { - "value": "ml.t3.medium", - "name": "ML_T3_MEDIUM" - }, - { - "value": "ml.t3.large", - "name": "ML_T3_LARGE" - }, - { - "value": "ml.t3.xlarge", - "name": "ML_T3_XLARGE" - }, - { - "value": "ml.t3.2xlarge", - "name": "ML_T3_2XLARGE" - }, - { - "value": "ml.m4.xlarge", - "name": "ML_M4_XLARGE" - }, - { - "value": "ml.m4.2xlarge", - "name": "ML_M4_2XLARGE" - }, - { - "value": "ml.m4.4xlarge", - "name": "ML_M4_4XLARGE" - }, - { - "value": "ml.m4.10xlarge", - "name": "ML_M4_10XLARGE" - }, - { - "value": "ml.m4.16xlarge", - "name": "ML_M4_16XLARGE" - }, - { - "value": "ml.m5.xlarge", - "name": "ML_M5_XLARGE" - }, - { - "value": "ml.m5.2xlarge", - "name": "ML_M5_2XLARGE" - }, - { - "value": "ml.m5.4xlarge", - "name": "ML_M5_4XLARGE" - }, - { - "value": "ml.m5.12xlarge", - "name": "ML_M5_12XLARGE" - }, - { - "value": "ml.m5.24xlarge", - "name": "ML_M5_24XLARGE" - }, - { - "value": "ml.m5d.large", - "name": "ML_M5D_LARGE" - }, - { - "value": "ml.m5d.xlarge", - "name": "ML_M5D_XLARGE" - }, - { - "value": "ml.m5d.2xlarge", - "name": "ML_M5D_2XLARGE" - }, - { - "value": "ml.m5d.4xlarge", - "name": "ML_M5D_4XLARGE" - }, - { - "value": "ml.m5d.8xlarge", - "name": "ML_M5D_8XLARGE" - }, - { - "value": "ml.m5d.12xlarge", - "name": "ML_M5D_12XLARGE" - }, - { - "value": "ml.m5d.16xlarge", - "name": "ML_M5D_16XLARGE" - }, - { - "value": "ml.m5d.24xlarge", - "name": "ML_M5D_24XLARGE" - }, - { - "value": "ml.c4.xlarge", - "name": "ML_C4_XLARGE" - }, - { - "value": "ml.c4.2xlarge", - "name": "ML_C4_2XLARGE" - }, - { - "value": "ml.c4.4xlarge", - "name": "ML_C4_4XLARGE" - }, - { - "value": "ml.c4.8xlarge", - "name": "ML_C4_8XLARGE" - }, - { - "value": "ml.c5.xlarge", - "name": "ML_C5_XLARGE" - }, - { - "value": "ml.c5.2xlarge", - "name": "ML_C5_2XLARGE" - }, - { - "value": "ml.c5.4xlarge", - "name": "ML_C5_4XLARGE" - }, - { - "value": "ml.c5.9xlarge", - "name": "ML_C5_9XLARGE" - }, - { - "value": "ml.c5.18xlarge", - "name": "ML_C5_18XLARGE" - }, - { - "value": "ml.c5d.xlarge", - "name": "ML_C5D_XLARGE" - }, - { - "value": "ml.c5d.2xlarge", - "name": "ML_C5D_2XLARGE" - }, - { - "value": "ml.c5d.4xlarge", - "name": "ML_C5D_4XLARGE" - }, - { - "value": "ml.c5d.9xlarge", - "name": "ML_C5D_9XLARGE" - }, - { - "value": "ml.c5d.18xlarge", - "name": "ML_C5D_18XLARGE" - }, - { - "value": "ml.p2.xlarge", - "name": "ML_P2_XLARGE" - }, - { - "value": "ml.p2.8xlarge", - "name": "ML_P2_8XLARGE" - }, - { - "value": "ml.p2.16xlarge", - "name": "ML_P2_16XLARGE" - }, - { - "value": "ml.p3.2xlarge", - "name": "ML_P3_2XLARGE" - }, - { - "value": "ml.p3.8xlarge", - "name": "ML_P3_8XLARGE" - }, - { - "value": "ml.p3.16xlarge", - "name": "ML_P3_16XLARGE" - }, - { - "value": "ml.p3dn.24xlarge", - "name": "ML_P3DN_24XLARGE" - }, - { - "value": "ml.g4dn.xlarge", - "name": "ML_G4DN_XLARGE" - }, - { - "value": "ml.g4dn.2xlarge", - "name": "ML_G4DN_2XLARGE" - }, - { - "value": "ml.g4dn.4xlarge", - "name": "ML_G4DN_4XLARGE" - }, - { - "value": "ml.g4dn.8xlarge", - "name": "ML_G4DN_8XLARGE" - }, - { - "value": "ml.g4dn.12xlarge", - "name": "ML_G4DN_12XLARGE" - }, - { - "value": "ml.g4dn.16xlarge", - "name": "ML_G4DN_16XLARGE" - }, - { - "value": "ml.r5.large", - "name": "ML_R5_LARGE" - }, - { - "value": "ml.r5.xlarge", - "name": "ML_R5_XLARGE" - }, - { - "value": "ml.r5.2xlarge", - "name": "ML_R5_2XLARGE" - }, - { - "value": "ml.r5.4xlarge", - "name": "ML_R5_4XLARGE" - }, - { - "value": "ml.r5.8xlarge", - "name": "ML_R5_8XLARGE" - }, - { - "value": "ml.r5.12xlarge", - "name": "ML_R5_12XLARGE" - }, - { - "value": "ml.r5.16xlarge", - "name": "ML_R5_16XLARGE" - }, - { - "value": "ml.r5.24xlarge", - "name": "ML_R5_24XLARGE" - }, - { - "value": "ml.g5.xlarge", - "name": "ML_G5_XLARGE" - }, - { - "value": "ml.g5.2xlarge", - "name": "ML_G5_2XLARGE" - }, - { - "value": "ml.g5.4xlarge", - "name": "ML_G5_4XLARGE" - }, - { - "value": "ml.g5.8xlarge", - "name": "ML_G5_8XLARGE" - }, - { - "value": "ml.g5.16xlarge", - "name": "ML_G5_16XLARGE" - }, - { - "value": "ml.g5.12xlarge", - "name": "ML_G5_12XLARGE" - }, - { - "value": "ml.g5.24xlarge", - "name": "ML_G5_24XLARGE" - }, - { - "value": "ml.g5.48xlarge", - "name": "ML_G5_48XLARGE" + "type": "enum", + "members": { + "ML_T2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.medium" + } + }, + "ML_T2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.large" + } + }, + "ML_T2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.xlarge" + } + }, + "ML_T2_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.2xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.8xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.16xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" } - ] + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.xlarge" + } + }, + "ML_C5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.2xlarge" + } + }, + "ML_C5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.4xlarge" + } + }, + "ML_C5D_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.9xlarge" + } + }, + "ML_C5D_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.18xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + } } }, "com.amazonaws.sagemaker#Integer": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.sagemaker#IntegerParameterRange": { "type": "structure", @@ -22223,12 +23013,14 @@ } }, "com.amazonaws.sagemaker#IntegerValue": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.sagemaker#InvocationsMaxRetries": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 3 @@ -22238,7 +23030,6 @@ "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 3600 @@ -22254,7 +23045,6 @@ "com.amazonaws.sagemaker#JobDurationInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -22280,18 +23070,20 @@ } }, "com.amazonaws.sagemaker#JoinSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Input", - "name": "INPUT" - }, - { - "value": "None", - "name": "NONE" + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" } - ] + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } } }, "com.amazonaws.sagemaker#JsonContentType": { @@ -22345,6 +23137,15 @@ "smithy.api#documentation": "The JupyterServer app settings.
" } }, + "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, "com.amazonaws.sagemaker#KernelDisplayName": { "type": "string", "traits": { @@ -22476,6 +23277,7 @@ "com.amazonaws.sagemaker#LabelCounter": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -22487,30 +23289,35 @@ "TotalLabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of objects labeled.
" } }, "HumanLabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of objects labeled by a human worker.
" } }, "MachineLabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of objects labeled by automated data labeling.
" } }, "FailedNonRetryableError": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of objects that could not be labeled due to an error.
" } }, "Unlabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of objects not yet labeled.
" } } @@ -22525,18 +23332,21 @@ "HumanLabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of data objects labeled by a human worker.
" } }, "PendingHuman": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of data objects that need to be labeled by a human worker.
" } }, "Total": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of tasks in the labeling job.
" } } @@ -22806,34 +23616,44 @@ } }, "com.amazonaws.sagemaker#LabelingJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Initializing", - "name": "INITIALIZING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#LabelingJobStoppingConditions": { @@ -23005,22 +23825,26 @@ } }, "com.amazonaws.sagemaker#LastUpdateStatusValue": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Successful", - "name": "SUCCESSFUL" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" + "type": "enum", + "members": { + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } } }, "com.amazonaws.sagemaker#LifecycleConfigArns": { @@ -23109,26 +23933,32 @@ } }, "com.amazonaws.sagemaker#LineageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TrialComponent", - "name": "TRIAL_COMPONENT" - }, - { - "value": "Artifact", - "name": "ARTIFACT" - }, - { - "value": "Context", - "name": "CONTEXT" - }, - { - "value": "Action", - "name": "ACTION" + "type": "enum", + "members": { + "TRIAL_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrialComponent" + } + }, + "ARTIFACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Artifact" + } + }, + "CONTEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Context" } - ] + }, + "ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Action" + } + } } }, "com.amazonaws.sagemaker#ListActions": { @@ -23753,7 +24583,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#AutoMLMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Request a list of jobs up to a specified limit.
" } }, @@ -23843,7 +24673,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#AutoMLMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "List the job's candidates up to a specified limit.
" } }, @@ -23998,7 +24828,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of model compilation jobs to return in the response.
" } }, @@ -24071,22 +24900,26 @@ } }, "com.amazonaws.sagemaker#ListCompilationJobsSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "Status", - "name": "STATUS" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" } - ] + } } }, "com.amazonaws.sagemaker#ListContexts": { @@ -24301,7 +25134,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#ListMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to select.
" } }, @@ -24368,22 +25201,26 @@ } }, "com.amazonaws.sagemaker#ListDeviceFleetsSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NAME", - "name": "Name" - }, - { - "value": "CREATION_TIME", - "name": "CreationTime" - }, - { - "value": "LAST_MODIFIED_TIME", - "name": "LastModifiedTime" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" } - ] + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + } } }, "com.amazonaws.sagemaker#ListDevices": { @@ -24416,7 +25253,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#ListMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Maximum number of results to select.
" } }, @@ -24540,7 +25377,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#ListMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to select (50 by default).
" } }, @@ -24613,26 +25450,32 @@ } }, "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NAME", - "name": "Name" - }, - { - "value": "DEVICE_FLEET_NAME", - "name": "DeviceFleetName" - }, - { - "value": "CREATION_TIME", - "name": "CreationTime" - }, - { - "value": "LAST_MODIFIED_TIME", - "name": "LastModifiedTime" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" } - ] + }, + "DeviceFleetName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVICE_FLEET_NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + } } }, "com.amazonaws.sagemaker#ListEdgePackagingJobs": { @@ -24665,7 +25508,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#ListMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Maximum number of results to select.
" } }, @@ -24744,30 +25587,38 @@ } }, "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NAME", - "name": "Name" - }, - { - "value": "MODEL_NAME", - "name": "ModelName" - }, - { - "value": "CREATION_TIME", - "name": "CreationTime" - }, - { - "value": "LAST_MODIFIED_TIME", - "name": "LastModifiedTime" - }, - { - "value": "STATUS", - "name": "EdgePackagingJobStatus" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "ModelName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_NAME" } - ] + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + }, + "EdgePackagingJobStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } } }, "com.amazonaws.sagemaker#ListEndpointConfigs": { @@ -25168,7 +26019,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The\n maximum number of tuning jobs to return. The default value is\n 10.
" } }, @@ -25662,22 +26510,26 @@ } }, "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "Status", - "name": "STATUS" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" } - ] + } } }, "com.amazonaws.sagemaker#ListLabelingJobs": { @@ -25794,14 +26646,14 @@ } }, "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" } - ] + } } }, "com.amazonaws.sagemaker#ListLabelingJobsRequest": { @@ -25971,6 +26823,7 @@ "com.amazonaws.sagemaker#ListMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "max": 100 } @@ -27412,7 +28265,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of processing jobs to return in the response.
" } } @@ -27548,7 +28400,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#ListMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of requests to select.
" } }, @@ -27562,6 +28414,7 @@ "ExcludeDevicesDeployedInOtherStage": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Toggle for excluding devices deployed in other stages.
" } }, @@ -27733,7 +28586,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of work teams to return in each page of the response.
" } } @@ -27802,7 +28654,6 @@ "com.amazonaws.sagemaker#ListTagsMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 50 } @@ -27938,7 +28789,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of training jobs to return in the response.
" } }, @@ -27989,6 +28839,12 @@ "traits": { "smithy.api#documentation": "The sort order for results. The default is Ascending.
A filter that retrieves only training jobs with a specific warm pool status.
" + } } } }, @@ -28088,7 +28944,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of transform jobs to return in the response. The default value is 10.
The maximum number of workforces returned in the response.
" } } @@ -28459,18 +29313,20 @@ } }, "com.amazonaws.sagemaker#ListWorkforcesSortByOptions": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "CreateDate", - "name": "CreateDate" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "CreateDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDate" + } + } } }, "com.amazonaws.sagemaker#ListWorkteams": { @@ -28521,7 +29377,6 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of work teams to return in each page of the response.
" } } @@ -28546,27 +29401,31 @@ } }, "com.amazonaws.sagemaker#ListWorkteamsSortByOptions": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "CreateDate", - "name": "CreateDate" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreateDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDate" } - ] + } } }, "com.amazonaws.sagemaker#Long": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28575,7 +29434,6 @@ "com.amazonaws.sagemaker#MaxCandidates": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28584,7 +29442,6 @@ "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 @@ -28594,7 +29451,6 @@ "com.amazonaws.sagemaker#MaxConcurrentTaskCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 5000 @@ -28604,7 +29460,6 @@ "com.amazonaws.sagemaker#MaxConcurrentTransforms": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -28613,7 +29468,6 @@ "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28622,7 +29476,6 @@ "com.amazonaws.sagemaker#MaxNumberOfTests": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28631,6 +29484,7 @@ "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -28639,6 +29493,7 @@ "com.amazonaws.sagemaker#MaxParallelExecutionSteps": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -28647,7 +29502,6 @@ "com.amazonaws.sagemaker#MaxParallelOfTests": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28656,6 +29510,7 @@ "com.amazonaws.sagemaker#MaxParallelTrainingJobs": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -28664,7 +29519,6 @@ "com.amazonaws.sagemaker#MaxPayloadInMB": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -28673,7 +29527,6 @@ "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -28683,7 +29536,6 @@ "com.amazonaws.sagemaker#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -28693,6 +29545,7 @@ "com.amazonaws.sagemaker#MaxRuntimeInSeconds": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -28701,7 +29554,6 @@ "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28710,7 +29562,6 @@ "com.amazonaws.sagemaker#MaxWaitTimeInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -28719,7 +29570,6 @@ "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 600, "max": 14400 @@ -28729,6 +29579,7 @@ "com.amazonaws.sagemaker#MaximumRetryAttempts": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 30 @@ -28831,6 +29682,7 @@ "Value": { "target": "com.amazonaws.sagemaker#Float", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The value of the metric.
" } }, @@ -28869,6 +29721,7 @@ "Value": { "target": "com.amazonaws.sagemaker#Float", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The value of the metric.
" } }, @@ -28944,26 +29797,33 @@ } }, "com.amazonaws.sagemaker#MetricSetSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Train", - "name": "TRAIN" - }, - { - "value": "Validation", - "name": "VALIDATION" - }, - { - "value": "Test", - "name": "TEST" + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Train" } - ] + }, + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validation" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Test" + } + } } }, "com.amazonaws.sagemaker#MetricValue": { - "type": "float" + "type": "float", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.sagemaker#MetricsSource": { "type": "structure", @@ -29004,22 +29864,26 @@ } }, "com.amazonaws.sagemaker#ModelApprovalStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Approved", - "name": "APPROVED" - }, - { - "value": "Rejected", - "name": "REJECTED" - }, - { - "value": "PendingManualApproval", - "name": "PENDING_MANUAL_APPROVAL" + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" } - ] + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "PENDING_MANUAL_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingManualApproval" + } + } } }, "com.amazonaws.sagemaker#ModelArn": { @@ -29114,18 +29978,20 @@ } }, "com.amazonaws.sagemaker#ModelCacheSetting": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled", - "name": "ENABLED" - }, - { - "value": "Disabled", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" } - ] + } } }, "com.amazonaws.sagemaker#ModelClientConfig": { @@ -29194,6 +30060,7 @@ "AutoGenerateEndpointName": { "target": "com.amazonaws.sagemaker#AutoGenerateEndpointName", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Set to True to automatically generate an endpoint name for a one-click\n Autopilot model deployment; set to False otherwise. The default value is\n False.
If you set AutoGenerateEndpointName to True, do not specify\n the EndpointName; otherwise a 400 error is thrown.
The model latency percentile value in milliseconds.
" } } @@ -29373,26 +30241,32 @@ } }, "com.amazonaws.sagemaker#ModelMetadataFilterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Domain", - "name": "DOMAIN" - }, - { - "value": "Framework", - "name": "FRAMEWORK" - }, - { - "value": "Task", - "name": "TASK" - }, - { - "value": "FrameworkVersion", - "name": "FRAMEWORKVERSION" + "type": "enum", + "members": { + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "FRAMEWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Framework" } - ] + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Task" + } + }, + "FRAMEWORKVERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FrameworkVersion" + } + } } }, "com.amazonaws.sagemaker#ModelMetadataFilters": { @@ -29594,6 +30468,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For\n information about listing model packages on Amazon Web Services Marketplace, see List Your\n Algorithm or Model Package on Amazon Web Services Marketplace.
" } }, @@ -29847,49 +30722,61 @@ } }, "com.amazonaws.sagemaker#ModelPackageGroupSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } } }, "com.amazonaws.sagemaker#ModelPackageGroupStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Deleting", - "name": "DELETING" - }, - { - "value": "DeleteFailed", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" } - ] + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } } }, "com.amazonaws.sagemaker#ModelPackageGroupSummary": { @@ -29941,45 +30828,55 @@ } }, "com.amazonaws.sagemaker#ModelPackageSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } } }, "com.amazonaws.sagemaker#ModelPackageStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Deleting", - "name": "DELETING" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" } - ] + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } } }, "com.amazonaws.sagemaker#ModelPackageStatusDetails": { @@ -30113,22 +31010,26 @@ } }, "com.amazonaws.sagemaker#ModelPackageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Versioned", - "name": "VERSIONED" - }, - { - "value": "Unversioned", - "name": "UNVERSIONED" - }, - { - "value": "Both", - "name": "BOTH" + "type": "enum", + "members": { + "VERSIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Versioned" + } + }, + "UNVERSIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unversioned" + } + }, + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Both" } - ] + } } }, "com.amazonaws.sagemaker#ModelPackageValidationProfile": { @@ -30190,7 +31091,6 @@ "com.amazonaws.sagemaker#ModelPackageVersion": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -30306,18 +31206,20 @@ } }, "com.amazonaws.sagemaker#ModelSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "CreationTime", - "name": "CreationTime" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } } }, "com.amazonaws.sagemaker#ModelStepMetadata": { @@ -30511,22 +31413,26 @@ } }, "com.amazonaws.sagemaker#MonitoringExecutionSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "ScheduledTime", - "name": "SCHEDULED_TIME" - }, - { - "value": "Status", - "name": "STATUS" + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "SCHEDULED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScheduledTime" } - ] + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } } }, "com.amazonaws.sagemaker#MonitoringExecutionSummary": { @@ -30737,18 +31643,20 @@ } }, "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" } - ] + } } }, "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary": { @@ -30796,6 +31704,7 @@ "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 86400 @@ -30808,12 +31717,14 @@ "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to encrypt all communications between the instances used for the monitoring\n jobs. Choose True to encrypt communications. Encryption provides greater\n security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the monitoring job.
" } }, @@ -30874,22 +31785,26 @@ } }, "com.amazonaws.sagemaker#MonitoringProblemType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BinaryClassification", - "name": "BINARY_CLASSIFICATION" - }, - { - "value": "MulticlassClassification", - "name": "MULTICLASS_CLASSIFICATION" - }, - { - "value": "Regression", - "name": "REGRESSION" + "type": "enum", + "members": { + "BINARY_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BinaryClassification" + } + }, + "MULTICLASS_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MulticlassClassification" } - ] + }, + "REGRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regression" + } + } } }, "com.amazonaws.sagemaker#MonitoringResources": { @@ -31072,22 +31987,26 @@ } }, "com.amazonaws.sagemaker#MonitoringScheduleSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "Status", - "name": "STATUS" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" } - ] + } } }, "com.amazonaws.sagemaker#MonitoringScheduleSummary": { @@ -31177,6 +32096,7 @@ "MaxRuntimeInSeconds": { "target": "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum runtime allowed in seconds.
\nThe MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and\n model explainability, this can be up to 3600 seconds for an hourly schedule. For model\n bias and model quality hourly schedules, this can be up to 1800 seconds.
Whether to encrypt all communications between distributed processing jobs. Choose\n True to encrypt communications. Encryption provides greater security for distributed\n processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the processing job.
" } }, @@ -31390,34 +32318,44 @@ } }, "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ml.eia1.medium", - "name": "ML_EIA1_MEDIUM" - }, - { - "value": "ml.eia1.large", - "name": "ML_EIA1_LARGE" - }, - { - "value": "ml.eia1.xlarge", - "name": "ML_EIA1_XLARGE" - }, - { - "value": "ml.eia2.medium", - "name": "ML_EIA2_MEDIUM" - }, - { - "value": "ml.eia2.large", - "name": "ML_EIA2_LARGE" - }, - { - "value": "ml.eia2.xlarge", - "name": "ML_EIA2_XLARGE" + "type": "enum", + "members": { + "ML_EIA1_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.medium" + } + }, + "ML_EIA1_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.large" + } + }, + "ML_EIA1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.xlarge" } - ] + }, + "ML_EIA2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.medium" + } + }, + "ML_EIA2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.large" + } + }, + "ML_EIA2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.xlarge" + } + } } }, "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes": { @@ -31487,37 +32425,43 @@ } }, "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "LastModifiedTime", - "name": "LAST_MODIFIED_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" } - ] + } } }, "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "ASCENDING" - }, - { - "value": "Descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" } - ] + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } } }, "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary": { @@ -31595,72 +32539,90 @@ } }, "com.amazonaws.sagemaker#NotebookInstanceSortKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" - }, - { - "value": "Status", - "name": "STATUS" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" } - ] + } } }, "com.amazonaws.sagemaker#NotebookInstanceSortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "ASCENDING" - }, - { - "value": "Descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" } - ] + } } }, "com.amazonaws.sagemaker#NotebookInstanceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "Pending" - }, - { - "value": "InService", - "name": "InService" - }, - { - "value": "Stopping", - "name": "Stopping" - }, - { - "value": "Stopped", - "name": "Stopped" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Deleting", - "name": "Deleting" - }, - { - "value": "Updating", - "name": "Updating" + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" } - ] + } } }, "com.amazonaws.sagemaker#NotebookInstanceSummary": { @@ -31745,7 +32707,6 @@ "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 16384 @@ -31753,18 +32714,20 @@ } }, "com.amazonaws.sagemaker#NotebookOutputOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Allowed", - "name": "Allowed" - }, - { - "value": "Disabled", - "name": "Disabled" + "type": "enum", + "members": { + "Allowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allowed" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" } - ] + } } }, "com.amazonaws.sagemaker#NotificationConfiguration": { @@ -31790,7 +32753,6 @@ "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 9 @@ -31798,27 +32760,32 @@ } }, "com.amazonaws.sagemaker#ObjectiveStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Succeeded", - "name": "Succeeded" - }, - { - "value": "Pending", - "name": "Pending" - }, - { - "value": "Failed", - "name": "Failed" + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + } } }, "com.amazonaws.sagemaker#ObjectiveStatusCounter": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -31830,18 +32797,21 @@ "Succeeded": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of training jobs whose final objective metric was evaluated by the\n hyperparameter tuning job and used in the hyperparameter tuning process.
" } }, "Pending": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of training jobs that are in progress and pending evaluation of their final\n objective metric.
" } }, "Failed": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of training jobs whose final objective metric was not evaluated and used in\n the hyperparameter tuning process. This typically occurs when the training job failed or\n did not emit an objective metric.
" } } @@ -31863,6 +32833,7 @@ "DisableGlueTableCreation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Set to True to disable the automatic creation of an Amazon Web Services Glue table when\n configuring an OfflineStore.
Turn OnlineStore off by specifying False \n for the EnableOnlineStore flag. Turn OnlineStore \n on by specifying True \n for the EnableOnlineStore flag.
The default value is False.
The max number of steps that can be executed in parallel.
", "smithy.api#required": {} } @@ -32404,26 +33393,32 @@ } }, "com.amazonaws.sagemaker#ParameterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Integer", - "name": "INTEGER" - }, - { - "value": "Continuous", - "name": "CONTINUOUS" - }, - { - "value": "Categorical", - "name": "CATEGORICAL" - }, - { - "value": "FreeText", - "name": "FREE_TEXT" + "type": "enum", + "members": { + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Integer" + } + }, + "CONTINUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continuous" + } + }, + "CATEGORICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Categorical" + } + }, + "FREE_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeText" } - ] + } } }, "com.amazonaws.sagemaker#ParameterValue": { @@ -32616,6 +33611,7 @@ "com.amazonaws.sagemaker#Percentage": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "max": 100 } @@ -32914,30 +33910,38 @@ } }, "com.amazonaws.sagemaker#PipelineExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Executing", - "name": "EXECUTING" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Succeeded", - "name": "SUCCEEDED" + "type": "enum", + "members": { + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Executing" } - ] + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } } }, "com.amazonaws.sagemaker#PipelineExecutionStep": { @@ -32988,6 +33992,7 @@ "AttemptCount": { "target": "com.amazonaws.sagemaker#IntegerValue", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
" } }, @@ -33203,14 +34208,14 @@ } }, "com.amazonaws.sagemaker#PipelineStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" } - ] + } } }, "com.amazonaws.sagemaker#PipelineSummary": { @@ -33305,28 +34310,29 @@ "type": "string" }, "com.amazonaws.sagemaker#ProbabilityThresholdAttribute": { - "type": "double", - "traits": { - "smithy.api#box": {} - } + "type": "double" }, "com.amazonaws.sagemaker#ProblemType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BinaryClassification", - "name": "BINARY_CLASSIFICATION" - }, - { - "value": "MulticlassClassification", - "name": "MULTICLASS_CLASSIFICATION" - }, - { - "value": "Regression", - "name": "REGRESSION" + "type": "enum", + "members": { + "BINARY_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BinaryClassification" } - ] + }, + "MULTICLASS_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MulticlassClassification" + } + }, + "REGRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regression" + } + } } }, "com.amazonaws.sagemaker#ProcessingClusterConfig": { @@ -33427,6 +34433,7 @@ "AppManaged": { "target": "com.amazonaws.sagemaker#AppManaged", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When True, input operations such as data download are managed natively by the\n processing job application. When False (default), input operations are managed by Amazon SageMaker.
When True, output operations such as data upload are managed natively by the\n processing job application. When False (default), output operations are managed by\n Amazon SageMaker.
Specifies the maximum runtime in seconds.
", "smithy.api#required": {} } @@ -34169,7 +35282,6 @@ "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 16384 @@ -34248,19 +35360,19 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB", "traits": { - "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to individual\n inference instance associated with the production variant. Currenly only\n Amazon EBS gp2 storage volumes are supported.
" + "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to individual inference instance\n associated with the production variant. Currenly only Amazon EBS gp2 storage volumes are\n supported.
" } }, "ModelDataDownloadTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", "traits": { - "smithy.api#documentation": "The timeout value, in seconds, to download and extract the\n model that you want to host from Amazon S3 to the individual inference instance associated with\n this production variant.
" + "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this production\n variant.
" } }, "ContainerStartupHealthCheckTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", "traits": { - "smithy.api#documentation": "The timeout value, in seconds, for your inference container\n to pass health check by SageMaker Hosting. For more information about health\n check, see How\n Your Container Should Respond to Health Check (Ping)\n Requests.
" + "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" } } }, @@ -34269,40 +35381,49 @@ } }, "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ml.eia1.medium", - "name": "ML_EIA1_MEDIUM" - }, - { - "value": "ml.eia1.large", - "name": "ML_EIA1_LARGE" - }, - { - "value": "ml.eia1.xlarge", - "name": "ML_EIA1_XLARGE" - }, - { - "value": "ml.eia2.medium", - "name": "ML_EIA2_MEDIUM" - }, - { - "value": "ml.eia2.large", - "name": "ML_EIA2_LARGE" - }, - { - "value": "ml.eia2.xlarge", - "name": "ML_EIA2_XLARGE" + "type": "enum", + "members": { + "ML_EIA1_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.medium" + } + }, + "ML_EIA1_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.large" } - ] + }, + "ML_EIA1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.xlarge" + } + }, + "ML_EIA2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.medium" + } + }, + "ML_EIA2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.large" + } + }, + "ML_EIA2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.xlarge" + } + } } }, "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 3600 @@ -34331,346 +35452,512 @@ } }, "com.amazonaws.sagemaker#ProductionVariantInstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ml.t2.medium", - "name": "ML_T2_MEDIUM" - }, - { - "value": "ml.t2.large", - "name": "ML_T2_LARGE" - }, - { - "value": "ml.t2.xlarge", - "name": "ML_T2_XLARGE" - }, - { - "value": "ml.t2.2xlarge", - "name": "ML_T2_2XLARGE" - }, - { - "value": "ml.m4.xlarge", - "name": "ML_M4_XLARGE" - }, - { - "value": "ml.m4.2xlarge", - "name": "ML_M4_2XLARGE" - }, - { - "value": "ml.m4.4xlarge", - "name": "ML_M4_4XLARGE" - }, - { - "value": "ml.m4.10xlarge", - "name": "ML_M4_10XLARGE" - }, - { - "value": "ml.m4.16xlarge", - "name": "ML_M4_16XLARGE" - }, - { - "value": "ml.m5.large", - "name": "ML_M5_LARGE" - }, - { - "value": "ml.m5.xlarge", - "name": "ML_M5_XLARGE" - }, - { - "value": "ml.m5.2xlarge", - "name": "ML_M5_2XLARGE" - }, - { - "value": "ml.m5.4xlarge", - "name": "ML_M5_4XLARGE" - }, - { - "value": "ml.m5.12xlarge", - "name": "ML_M5_12XLARGE" - }, - { - "value": "ml.m5.24xlarge", - "name": "ML_M5_24XLARGE" - }, - { - "value": "ml.m5d.large", - "name": "ML_M5D_LARGE" - }, - { - "value": "ml.m5d.xlarge", - "name": "ML_M5D_XLARGE" - }, - { - "value": "ml.m5d.2xlarge", - "name": "ML_M5D_2XLARGE" - }, - { - "value": "ml.m5d.4xlarge", - "name": "ML_M5D_4XLARGE" - }, - { - "value": "ml.m5d.12xlarge", - "name": "ML_M5D_12XLARGE" - }, - { - "value": "ml.m5d.24xlarge", - "name": "ML_M5D_24XLARGE" - }, - { - "value": "ml.c4.large", - "name": "ML_C4_LARGE" - }, - { - "value": "ml.c4.xlarge", - "name": "ML_C4_XLARGE" - }, - { - "value": "ml.c4.2xlarge", - "name": "ML_C4_2XLARGE" - }, - { - "value": "ml.c4.4xlarge", - "name": "ML_C4_4XLARGE" - }, - { - "value": "ml.c4.8xlarge", - "name": "ML_C4_8XLARGE" - }, - { - "value": "ml.p2.xlarge", - "name": "ML_P2_XLARGE" - }, - { - "value": "ml.p2.8xlarge", - "name": "ML_P2_8XLARGE" - }, - { - "value": "ml.p2.16xlarge", - "name": "ML_P2_16XLARGE" - }, - { - "value": "ml.p3.2xlarge", - "name": "ML_P3_2XLARGE" - }, - { - "value": "ml.p3.8xlarge", - "name": "ML_P3_8XLARGE" - }, - { - "value": "ml.p3.16xlarge", - "name": "ML_P3_16XLARGE" - }, - { - "value": "ml.c5.large", - "name": "ML_C5_LARGE" - }, - { - "value": "ml.c5.xlarge", - "name": "ML_C5_XLARGE" - }, - { - "value": "ml.c5.2xlarge", - "name": "ML_C5_2XLARGE" - }, - { - "value": "ml.c5.4xlarge", - "name": "ML_C5_4XLARGE" - }, - { - "value": "ml.c5.9xlarge", - "name": "ML_C5_9XLARGE" - }, - { - "value": "ml.c5.18xlarge", - "name": "ML_C5_18XLARGE" - }, - { - "value": "ml.c5d.large", - "name": "ML_C5D_LARGE" - }, - { - "value": "ml.c5d.xlarge", - "name": "ML_C5D_XLARGE" - }, - { - "value": "ml.c5d.2xlarge", - "name": "ML_C5D_2XLARGE" - }, - { - "value": "ml.c5d.4xlarge", - "name": "ML_C5D_4XLARGE" - }, - { - "value": "ml.c5d.9xlarge", - "name": "ML_C5D_9XLARGE" - }, - { - "value": "ml.c5d.18xlarge", - "name": "ML_C5D_18XLARGE" - }, - { - "value": "ml.g4dn.xlarge", - "name": "ML_G4DN_XLARGE" - }, - { - "value": "ml.g4dn.2xlarge", - "name": "ML_G4DN_2XLARGE" - }, - { - "value": "ml.g4dn.4xlarge", - "name": "ML_G4DN_4XLARGE" - }, - { - "value": "ml.g4dn.8xlarge", - "name": "ML_G4DN_8XLARGE" - }, - { - "value": "ml.g4dn.12xlarge", - "name": "ML_G4DN_12XLARGE" - }, - { - "value": "ml.g4dn.16xlarge", - "name": "ML_G4DN_16XLARGE" - }, - { - "value": "ml.r5.large", - "name": "ML_R5_LARGE" - }, - { - "value": "ml.r5.xlarge", - "name": "ML_R5_XLARGE" - }, - { - "value": "ml.r5.2xlarge", - "name": "ML_R5_2XLARGE" - }, - { - "value": "ml.r5.4xlarge", - "name": "ML_R5_4XLARGE" - }, - { - "value": "ml.r5.12xlarge", - "name": "ML_R5_12XLARGE" - }, - { - "value": "ml.r5.24xlarge", - "name": "ML_R5_24XLARGE" - }, - { - "value": "ml.r5d.large", - "name": "ML_R5D_LARGE" - }, - { - "value": "ml.r5d.xlarge", - "name": "ML_R5D_XLARGE" - }, - { - "value": "ml.r5d.2xlarge", - "name": "ML_R5D_2XLARGE" - }, - { - "value": "ml.r5d.4xlarge", - "name": "ML_R5D_4XLARGE" - }, - { - "value": "ml.r5d.12xlarge", - "name": "ML_R5D_12XLARGE" - }, - { - "value": "ml.r5d.24xlarge", - "name": "ML_R5D_24XLARGE" - }, - { - "value": "ml.inf1.xlarge", - "name": "ML_INF1_XLARGE" - }, - { - "value": "ml.inf1.2xlarge", - "name": "ML_INF1_2XLARGE" - }, - { - "value": "ml.inf1.6xlarge", - "name": "ML_INF1_6XLARGE" - }, - { - "value": "ml.inf1.24xlarge", - "name": "ML_INF1_24XLARGE" - }, - { - "value": "ml.c6i.large", - "name": "ML_C6I_LARGE" - }, - { - "value": "ml.c6i.xlarge", - "name": "ML_C6I_XLARGE" - }, - { - "value": "ml.c6i.2xlarge", - "name": "ML_C6I_2XLARGE" - }, - { - "value": "ml.c6i.4xlarge", - "name": "ML_C6I_4XLARGE" - }, - { - "value": "ml.c6i.8xlarge", - "name": "ML_C6I_8XLARGE" - }, - { - "value": "ml.c6i.12xlarge", - "name": "ML_C6I_12XLARGE" - }, - { - "value": "ml.c6i.16xlarge", - "name": "ML_C6I_16XLARGE" - }, - { - "value": "ml.c6i.24xlarge", - "name": "ML_C6I_24XLARGE" - }, - { - "value": "ml.c6i.32xlarge", - "name": "ML_C6I_32XLARGE" - }, - { - "value": "ml.g5.xlarge", - "name": "ML_G5_XLARGE" - }, - { - "value": "ml.g5.2xlarge", - "name": "ML_G5_2XLARGE" - }, - { - "value": "ml.g5.4xlarge", - "name": "ML_G5_4XLARGE" - }, - { - "value": "ml.g5.8xlarge", - "name": "ML_G5_8XLARGE" - }, - { - "value": "ml.g5.12xlarge", - "name": "ML_G5_12XLARGE" - }, - { - "value": "ml.g5.16xlarge", - "name": "ML_G5_16XLARGE" - }, - { - "value": "ml.g5.24xlarge", - "name": "ML_G5_24XLARGE" - }, - { - "value": "ml.g5.48xlarge", - "name": "ML_G5_48XLARGE" - }, - { - "value": "ml.p4d.24xlarge", - "name": "ML_P4D_24XLARGE" + "type": "enum", + "members": { + "ML_T2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.medium" + } + }, + "ML_T2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.large" + } + }, + "ML_T2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.xlarge" + } + }, + "ML_T2_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C4_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.large" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" } - ] + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.large" + } + }, + "ML_C5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.xlarge" + } + }, + "ML_C5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.2xlarge" + } + }, + "ML_C5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.4xlarge" + } + }, + "ML_C5D_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.9xlarge" + } + }, + "ML_C5D_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.18xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_R5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.large" + } + }, + "ML_R5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.xlarge" + } + }, + "ML_R5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.2xlarge" + } + }, + "ML_R5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.4xlarge" + } + }, + "ML_R5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.12xlarge" + } + }, + "ML_R5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.24xlarge" + } + }, + "ML_INF1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.xlarge" + } + }, + "ML_INF1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.2xlarge" + } + }, + "ML_INF1_6XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.6xlarge" + } + }, + "ML_INF1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.24xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + } } }, "com.amazonaws.sagemaker#ProductionVariantList": { @@ -34688,7 +35975,6 @@ "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 3600 @@ -34833,7 +36119,6 @@ "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 512 @@ -34891,6 +36176,7 @@ "DisableProfiler": { "target": "com.amazonaws.sagemaker#DisableProfiler", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "To disable Debugger monitoring and profiling, set to True.
The size, in GB, of the ML storage volume attached to the processing instance.
" } }, @@ -35014,10 +36301,7 @@ } }, "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.sagemaker#ProfilingParameters": { "type": "map", @@ -35035,18 +36319,20 @@ } }, "com.amazonaws.sagemaker#ProfilingStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled", - "name": "ENABLED" - }, - { - "value": "Disabled", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" } - ] + } } }, "com.amazonaws.sagemaker#Project": { @@ -35151,80 +36437,102 @@ } }, "com.amazonaws.sagemaker#ProjectSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "CreationTime", - "name": "CREATION_TIME" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" } - ] + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } } }, "com.amazonaws.sagemaker#ProjectSortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "ASCENDING" - }, - { - "value": "Descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" } - ] + } } }, "com.amazonaws.sagemaker#ProjectStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "CreateInProgress", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CreateCompleted", - "name": "CREATE_COMPLETED" - }, - { - "value": "CreateFailed", - "name": "CREATE_FAILED" - }, - { - "value": "DeleteInProgress", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DeleteFailed", - "name": "DELETE_FAILED" - }, - { - "value": "DeleteCompleted", - "name": "DELETE_COMPLETED" - }, - { - "value": "UpdateInProgress", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "UpdateCompleted", - "name": "UPDATE_COMPLETED" - }, - { - "value": "UpdateFailed", - "name": "UPDATE_FAILED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInProgress" + } + }, + "CREATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateCompleted" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInProgress" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCompleted" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateInProgress" + } + }, + "UPDATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateCompleted" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" } - ] + } } }, "com.amazonaws.sagemaker#ProjectSummary": { @@ -35490,12 +36798,14 @@ "SkipCheck": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints and \n BaselineUsedForDriftCheckStatistics properties.
Setting this value to True retrieves not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.
The maximum number of requests per minute expected for the endpoint.
" } }, @@ -36104,18 +37428,20 @@ } }, "com.amazonaws.sagemaker#RecommendationJobType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Default", - "name": "DEFAULT" - }, - { - "value": "Advanced", - "name": "ADVANCED" + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default" } - ] + }, + "ADVANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Advanced" + } + } } }, "com.amazonaws.sagemaker#RecommendationMetrics": { @@ -36124,6 +37450,7 @@ "CostPerHour": { "target": "com.amazonaws.sagemaker#Float", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Defines the cost per hour for the instance.
", "smithy.api#required": {} } @@ -36131,6 +37458,7 @@ "CostPerInference": { "target": "com.amazonaws.sagemaker#Float", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Defines the cost per inference for the instance .
", "smithy.api#required": {} } @@ -36138,6 +37466,7 @@ "MaxInvocations": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The expected maximum number of requests per minute for the instance.
", "smithy.api#required": {} } @@ -36145,6 +37474,7 @@ "ModelLatency": { "target": "com.amazonaws.sagemaker#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The expected model latency at maximum invocation per minute for the instance.
", "smithy.api#required": {} } @@ -36155,18 +37485,20 @@ } }, "com.amazonaws.sagemaker#RecordWrapper": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "None", - "name": "NONE" - }, - { - "value": "RecordIO", - "name": "RECORDIO" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" } - ] + }, + "RECORDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecordIO" + } + } } }, "com.amazonaws.sagemaker#RedshiftClusterId": { @@ -36264,47 +37596,61 @@ } }, "com.amazonaws.sagemaker#RedshiftResultCompressionType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The compression used for Redshift query results.
", - "smithy.api#enum": [ - { - "value": "None", - "name": "NONE" - }, - { - "value": "GZIP", - "name": "GZIP" - }, - { - "value": "BZIP2", - "name": "BZIP2" - }, - { - "value": "ZSTD", - "name": "ZSTD" - }, - { - "value": "SNAPPY", - "name": "SNAPPY" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" } - ] + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "BZIP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZIP2" + } + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" + } + } + }, + "traits": { + "smithy.api#documentation": "The compression used for Redshift query results.
" } }, "com.amazonaws.sagemaker#RedshiftResultFormat": { - "type": "string", - "traits": { - "smithy.api#documentation": "The data storage format for Redshift query results.
", - "smithy.api#enum": [ - { - "value": "PARQUET", - "name": "PARQUET" - }, - { - "value": "CSV", - "name": "CSV" + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" } - ] + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + }, + "traits": { + "smithy.api#documentation": "The data storage format for Redshift query results.
" } }, "com.amazonaws.sagemaker#RedshiftUserName": { @@ -36485,18 +37831,20 @@ } }, "com.amazonaws.sagemaker#RepositoryAccessMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Platform", - "name": "PLATFORM" - }, - { - "value": "Vpc", - "name": "VPC" + "type": "enum", + "members": { + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Platform" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vpc" } - ] + } } }, "com.amazonaws.sagemaker#RepositoryAuthConfig": { @@ -36566,12 +37914,14 @@ "InstanceCount": { "target": "com.amazonaws.sagemaker#TrainingInstanceCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of ML compute instances to use. For distributed training, provide a\n value greater than 1.
" } }, "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#VolumeSizeInGB", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size of the ML storage volume that you want to provision.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.
When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
\nTo find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.
", "smithy.api#required": {} } @@ -36587,12 +37937,33 @@ "traits": { "smithy.api#documentation": "The configuration of a heterogeneous cluster in JSON format.
" } + }, + "KeepAlivePeriodInSeconds": { + "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", + "traits": { + "smithy.api#documentation": "The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
" + } } }, "traits": { "smithy.api#documentation": "Describes the resources, including ML compute instances and ML storage volumes, to\n use for model training.
" } }, + "com.amazonaws.sagemaker#ResourceConfigForUpdate": { + "type": "structure", + "members": { + "KeepAlivePeriodInSeconds": { + "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", + "traits": { + "smithy.api#documentation": "The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.
The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.
The\n maximum\n number of training jobs that a hyperparameter tuning job can\n launch.
", "smithy.api#required": {} } @@ -36639,6 +38011,7 @@ "MaxParallelTrainingJobs": { "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The\n maximum\n number of concurrent training jobs that a hyperparameter tuning job can\n launch.
", "smithy.api#required": {} } @@ -36680,6 +38053,14 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.sagemaker#ResourceRetainedBillableTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#ResourceSpec": { "type": "structure", "members": { @@ -36713,62 +38094,86 @@ } }, "com.amazonaws.sagemaker#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TrainingJob", - "name": "TRAINING_JOB" - }, - { - "value": "Experiment", - "name": "EXPERIMENT" - }, - { - "value": "ExperimentTrial", - "name": "EXPERIMENT_TRIAL" - }, - { - "value": "ExperimentTrialComponent", - "name": "EXPERIMENT_TRIAL_COMPONENT" - }, - { - "value": "Endpoint", - "name": "ENDPOINT" - }, - { - "value": "ModelPackage", - "name": "MODEL_PACKAGE" - }, - { - "value": "ModelPackageGroup", - "name": "MODEL_PACKAGE_GROUP" - }, - { - "value": "Pipeline", - "name": "PIPELINE" - }, - { - "value": "PipelineExecution", - "name": "PIPELINE_EXECUTION" - }, - { - "value": "FeatureGroup", - "name": "FEATURE_GROUP" - }, - { - "value": "Project", - "name": "PROJECT" - }, - { - "value": "FeatureMetadata", - "name": "FEATURE_METADATA" - }, - { - "value": "HyperParameterTuningJob", - "name": "HYPER_PARAMETER_TUNING_JOB" + "type": "enum", + "members": { + "TRAINING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingJob" + } + }, + "EXPERIMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Experiment" + } + }, + "EXPERIMENT_TRIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExperimentTrial" + } + }, + "EXPERIMENT_TRIAL_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExperimentTrialComponent" + } + }, + "ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Endpoint" + } + }, + "MODEL_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelPackage" + } + }, + "MODEL_PACKAGE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelPackageGroup" + } + }, + "PIPELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipeline" + } + }, + "PIPELINE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PipelineExecution" + } + }, + "FEATURE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureGroup" + } + }, + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Project" } - ] + }, + "FEATURE_METADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureMetadata" + } + }, + "HYPER_PARAMETER_TUNING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HyperParameterTuningJob" + } + } } }, "com.amazonaws.sagemaker#ResponseMIMEType": { @@ -36802,18 +38207,20 @@ } }, "com.amazonaws.sagemaker#RetentionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Retain", - "name": "Retain" - }, - { - "value": "Delete", - "name": "Delete" + "type": "enum", + "members": { + "Retain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retain" + } + }, + "Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete" } - ] + } } }, "com.amazonaws.sagemaker#RetryPipelineExecution": { @@ -36882,6 +38289,7 @@ "MaximumRetryAttempts": { "target": "com.amazonaws.sagemaker#MaximumRetryAttempts", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of times to retry the job. When the job is retried, it's\n SecondaryStatus is changed to STARTING.
Provides APIs for creating and managing SageMaker resources.
\nOther Resources:
\nProvides APIs for creating and managing SageMaker resources.
\nOther Resources:
\nThe maximum number of results to return.
" } } @@ -38165,89 +39597,121 @@ } }, "com.amazonaws.sagemaker#SearchSortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Ascending", - "name": "ASCENDING" - }, - { - "value": "Descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" } - ] + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } } }, "com.amazonaws.sagemaker#SecondaryStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Starting", - "name": "STARTING" - }, - { - "value": "LaunchingMLInstances", - "name": "LAUNCHING_ML_INSTANCES" - }, - { - "value": "PreparingTrainingStack", - "name": "PREPARING_TRAINING_STACK" - }, - { - "value": "Downloading", - "name": "DOWNLOADING" - }, - { - "value": "DownloadingTrainingImage", - "name": "DOWNLOADING_TRAINING_IMAGE" - }, - { - "value": "Training", - "name": "TRAINING" - }, - { - "value": "Uploading", - "name": "UPLOADING" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" - }, - { - "value": "MaxRuntimeExceeded", - "name": "MAX_RUNTIME_EXCEEDED" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Interrupted", - "name": "INTERRUPTED" - }, - { - "value": "MaxWaitTimeExceeded", - "name": "MAX_WAIT_TIME_EXCEEDED" - }, - { - "value": "Updating", - "name": "UPDATING" - }, - { - "value": "Restarting", - "name": "RESTARTING" + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "LAUNCHING_ML_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchingMLInstances" + } + }, + "PREPARING_TRAINING_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PreparingTrainingStack" + } + }, + "DOWNLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Downloading" + } + }, + "DOWNLOADING_TRAINING_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DownloadingTrainingImage" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Training" + } + }, + "UPLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Uploading" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "MAX_RUNTIME_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxRuntimeExceeded" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interrupted" + } + }, + "MAX_WAIT_TIME_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxWaitTimeExceeded" } - ] + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "RESTARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restarting" + } + } } }, "com.amazonaws.sagemaker#SecondaryStatusTransition": { @@ -38323,7 +39787,10 @@ } }, "com.amazonaws.sagemaker#Seed": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.sagemaker#SendPipelineExecutionStepFailure": { "type": "operation", @@ -38440,7 +39907,6 @@ "com.amazonaws.sagemaker#ServerlessMaxConcurrency": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 200 @@ -38450,7 +39916,6 @@ "com.amazonaws.sagemaker#ServerlessMemorySizeInMB": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1024, "max": 6144 @@ -38543,7 +40008,6 @@ "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1800, "max": 43200 @@ -38582,6 +40046,7 @@ "Seed": { "target": "com.amazonaws.sagemaker#Seed", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Determines the shuffling order in ShuffleConfig value.
The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.
\nFor compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.
The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.
Describes whether time series forecasting is enabled or disabled in the Canvas app.
" + } + }, + "AmazonForecastRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default,\n Canvas uses the execution role specified in the UserProfile that launches the Canvas app.\n If an execution role is not specified in the UserProfile, Canvas uses the execution\n role specified in the Domain that owns the UserProfile.\n To allow time series forecasting, this IAM role should have the\n \n AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added\n in the trust relationship as a service principal.
Time series forecast settings for the SageMaker Canvas app.
" + } + }, "com.amazonaws.sagemaker#Timestamp": { "type": "timestamp" }, "com.amazonaws.sagemaker#TrafficDurationInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -40451,33 +42076,37 @@ } }, "com.amazonaws.sagemaker#TrafficRoutingConfigType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALL_AT_ONCE", - "name": "ALL_AT_ONCE" - }, - { - "value": "CANARY", - "name": "CANARY" - }, - { - "value": "LINEAR", - "name": "LINEAR" + "type": "enum", + "members": { + "ALL_AT_ONCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_AT_ONCE" + } + }, + "CANARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANARY" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" } - ] + } } }, "com.amazonaws.sagemaker#TrafficType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PHASES", - "name": "PHASES" + "type": "enum", + "members": { + "PHASES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHASES" } - ] + } } }, "com.amazonaws.sagemaker#TrainingEnvironmentKey": { @@ -40516,226 +42145,325 @@ } }, "com.amazonaws.sagemaker#TrainingInputMode": { - "type": "string", - "traits": { - "smithy.api#documentation": "The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.
\n\n\n Pipe mode\n
\nIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.
\n File mode\n
\nIf an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.
\nFor distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.
\n\n\n FastFile mode\n
\nIf an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.
\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.
The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.
\n\n\n Pipe mode\n
\nIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.
\n File mode\n
\nIf an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.
\nFor distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.
\n\n\n FastFile mode\n
\nIf an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.
\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.
If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" } }, @@ -41021,18 +42752,20 @@ } }, "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Off", - "name": "OFF" - }, - { - "value": "Auto", - "name": "AUTO" + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Off" } - ] + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + } } }, "com.amazonaws.sagemaker#TrainingJobName": { @@ -41046,58 +42779,73 @@ } }, "com.amazonaws.sagemaker#TrainingJobSortByOptions": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "CreationTime", - "name": "CreationTime" - }, - { - "value": "Status", - "name": "Status" - }, - { - "value": "FinalObjectiveMetricValue", - "name": "FinalObjectiveMetricValue" + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" } - ] + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "FinalObjectiveMetricValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FinalObjectiveMetricValue" + } + } } }, "com.amazonaws.sagemaker#TrainingJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#TrainingJobStatusCounter": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -41109,30 +42857,35 @@ "Completed": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of completed training jobs launched by the hyperparameter tuning\n job.
" } }, "InProgress": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of in-progress training jobs launched by a hyperparameter tuning\n job.
" } }, "RetryableError": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.
" } }, "NonRetryableError": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.
" } }, "Stopped": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.
" } } @@ -41203,6 +42956,12 @@ "smithy.api#documentation": "The status of the training job.
", "smithy.api#required": {} } + }, + "WarmPoolStatus": { + "target": "com.amazonaws.sagemaker#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "The status of the warm pool associated with the training job.
" + } } }, "traits": { @@ -41241,6 +43000,7 @@ "SupportsDistributedTraining": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.
" } }, @@ -41271,7 +43031,6 @@ "com.amazonaws.sagemaker#TrainingTimeInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -41363,145 +43122,206 @@ "com.amazonaws.sagemaker#TransformInstanceCount": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.sagemaker#TransformInstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ml.m4.xlarge", - "name": "ML_M4_XLARGE" - }, - { - "value": "ml.m4.2xlarge", - "name": "ML_M4_2XLARGE" - }, - { - "value": "ml.m4.4xlarge", - "name": "ML_M4_4XLARGE" - }, - { - "value": "ml.m4.10xlarge", - "name": "ML_M4_10XLARGE" - }, - { - "value": "ml.m4.16xlarge", - "name": "ML_M4_16XLARGE" - }, - { - "value": "ml.c4.xlarge", - "name": "ML_C4_XLARGE" - }, - { - "value": "ml.c4.2xlarge", - "name": "ML_C4_2XLARGE" - }, - { - "value": "ml.c4.4xlarge", - "name": "ML_C4_4XLARGE" - }, - { - "value": "ml.c4.8xlarge", - "name": "ML_C4_8XLARGE" - }, - { - "value": "ml.p2.xlarge", - "name": "ML_P2_XLARGE" - }, - { - "value": "ml.p2.8xlarge", - "name": "ML_P2_8XLARGE" - }, - { - "value": "ml.p2.16xlarge", - "name": "ML_P2_16XLARGE" - }, - { - "value": "ml.p3.2xlarge", - "name": "ML_P3_2XLARGE" - }, - { - "value": "ml.p3.8xlarge", - "name": "ML_P3_8XLARGE" - }, - { - "value": "ml.p3.16xlarge", - "name": "ML_P3_16XLARGE" - }, - { - "value": "ml.c5.xlarge", - "name": "ML_C5_XLARGE" - }, - { - "value": "ml.c5.2xlarge", - "name": "ML_C5_2XLARGE" - }, - { - "value": "ml.c5.4xlarge", - "name": "ML_C5_4XLARGE" - }, - { - "value": "ml.c5.9xlarge", - "name": "ML_C5_9XLARGE" - }, - { - "value": "ml.c5.18xlarge", - "name": "ML_C5_18XLARGE" - }, - { - "value": "ml.m5.large", - "name": "ML_M5_LARGE" - }, - { - "value": "ml.m5.xlarge", - "name": "ML_M5_XLARGE" - }, - { - "value": "ml.m5.2xlarge", - "name": "ML_M5_2XLARGE" - }, - { - "value": "ml.m5.4xlarge", - "name": "ML_M5_4XLARGE" - }, - { - "value": "ml.m5.12xlarge", - "name": "ML_M5_12XLARGE" - }, - { - "value": "ml.m5.24xlarge", - "name": "ML_M5_24XLARGE" - }, - { - "value": "ml.g4dn.xlarge", - "name": "ML_G4DN_XLARGE" - }, - { - "value": "ml.g4dn.2xlarge", - "name": "ML_G4DN_2XLARGE" - }, - { - "value": "ml.g4dn.4xlarge", - "name": "ML_G4DN_4XLARGE" - }, - { - "value": "ml.g4dn.8xlarge", - "name": "ML_G4DN_8XLARGE" - }, - { - "value": "ml.g4dn.12xlarge", - "name": "ML_G4DN_12XLARGE" - }, - { - "value": "ml.g4dn.16xlarge", - "name": "ML_G4DN_16XLARGE" + "type": "enum", + "members": { + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" } - ] + } } }, "com.amazonaws.sagemaker#TransformInstanceTypes": { @@ -41705,30 +43525,38 @@ } }, "com.amazonaws.sagemaker#TransformJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#TransformJobStepMetadata": { @@ -42268,30 +44096,38 @@ } }, "com.amazonaws.sagemaker#TrialComponentPrimaryStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Completed", - "name": "COMPLETED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Stopping", - "name": "STOPPING" - }, - { - "value": "Stopped", - "name": "STOPPED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" } - ] + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } } }, "com.amazonaws.sagemaker#TrialComponentSimpleSummaries": { @@ -42615,18 +44451,21 @@ "Dollars": { "target": "com.amazonaws.sagemaker#Dollars", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The whole number of dollars in the amount.
" } }, "Cents": { "target": "com.amazonaws.sagemaker#Cents", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The fractional portion, in cents, of the amount.
" } }, "TenthFractionsOfACent": { "target": "com.amazonaws.sagemaker#TenthFractionsOfACent", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Fractions of a cent, in tenths.
" } } @@ -43147,6 +44986,7 @@ "RetainAllVariantProperties": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To\n retain the variant properties of an endpoint when updating it, set\n RetainAllVariantProperties to true. To use the variant\n properties specified in a new EndpointConfig call when updating an\n endpoint, set RetainAllVariantProperties to false. The default\n is false.
Specifies whether to reuse the last deployment configuration. The default value is\n false (the configuration is not reused).
" } } @@ -43618,6 +45459,7 @@ "DisassociateLifecycleConfig": { "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Set to true to remove the notebook instance lifecycle configuration\n currently associated with the notebook instance. This operation is idempotent. If you\n specify a lifecycle configuration that is not associated with the notebook instance when\n you call this method, it does not throw an error.
A list of the Elastic Inference (EI) instance types to remove from this notebook\n instance. This operation is idempotent. If you specify an accelerator type that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.
" } }, "DisassociateDefaultCodeRepository": { "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.
" } }, "DisassociateAdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A list of names or URLs of the default Git repositories to remove from this notebook\n instance. This operation is idempotent. If you specify a Git repository that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.
" } }, @@ -43928,7 +45773,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a model training job to request a new Debugger profiling configuration.
" + "smithy.api#documentation": "Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
" } }, "com.amazonaws.sagemaker#UpdateTrainingJobRequest": { @@ -43952,6 +45797,12 @@ "traits": { "smithy.api#documentation": "Configuration information for Debugger rules for profiling system and framework\n metrics.
" } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfigForUpdate", + "traits": { + "smithy.api#documentation": "The training job ResourceConfig to update warm pool retention length.
A collection of settings that configure the RSessionGateway app.
The Canvas app settings.
" + } } }, "traits": { @@ -44505,7 +46376,6 @@ "com.amazonaws.sagemaker#ValidationFraction": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 1 @@ -44550,49 +46420,61 @@ } }, "com.amazonaws.sagemaker#VariantPropertyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DesiredInstanceCount", - "name": "DesiredInstanceCount" - }, - { - "value": "DesiredWeight", - "name": "DesiredWeight" - }, - { - "value": "DataCaptureConfig", - "name": "DataCaptureConfig" + "type": "enum", + "members": { + "DesiredInstanceCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DesiredInstanceCount" } - ] + }, + "DesiredWeight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DesiredWeight" + } + }, + "DataCaptureConfig": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataCaptureConfig" + } + } } }, "com.amazonaws.sagemaker#VariantStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Creating", - "name": "CREATING" - }, - { - "value": "Updating", - "name": "UPDATING" - }, - { - "value": "Deleting", - "name": "DELETING" - }, - { - "value": "ActivatingTraffic", - "name": "ACTIVATING_TRAFFIC" - }, - { - "value": "Baking", - "name": "BAKING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" } - ] + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "ACTIVATING_TRAFFIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivatingTraffic" + } + }, + "BAKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Baking" + } + } } }, "com.amazonaws.sagemaker#VariantStatusMessage": { @@ -44607,7 +46489,6 @@ "com.amazonaws.sagemaker#VariantWeight": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -44668,6 +46549,7 @@ "com.amazonaws.sagemaker#VolumeSizeInGB": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -44720,13 +46602,68 @@ "com.amazonaws.sagemaker#WaitIntervalInSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 3600 } } }, + "com.amazonaws.sagemaker#WarmPoolResourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminated" + } + }, + "REUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Reused" + } + }, + "INUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InUse" + } + } + } + }, + "com.amazonaws.sagemaker#WarmPoolStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the warm pool.
\n\n InUse: The warm pool is in use for the training job.
\n Available: The warm pool is available to reuse for a matching training job.
\n Reused: The warm pool moved to a matching training job for reuse.
\n Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.
The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock\n time.
\nMultiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.
The name of the matching training job that reused the warm pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Status and billing information about the warm pool.
" + } + }, "com.amazonaws.sagemaker#Workforce": { "type": "structure", "members": { @@ -44856,30 +46793,38 @@ } }, "com.amazonaws.sagemaker#WorkforceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Initializing", - "name": "INITIALIZING" - }, - { - "value": "Updating", - "name": "UPDATING" - }, - { - "value": "Deleting", - "name": "DELETING" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Active", - "name": "ACTIVE" + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" } - ] + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + } } }, "com.amazonaws.sagemaker#WorkforceSubnetId": { diff --git a/codegen/sdk/aws-models/secrets-manager.json b/codegen/sdk/aws-models/secrets-manager.json index 8d607c80fae..9b7175c95aa 100644 --- a/codegen/sdk/aws-models/secrets-manager.json +++ b/codegen/sdk/aws-models/secrets-manager.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -43,6 +43,7 @@ "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000 @@ -50,7 +51,10 @@ } }, "com.amazonaws.secretsmanager#BooleanType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#CancelRotateSecret": { "type": "operation", @@ -75,7 +79,7 @@ } ], "traits": { - "smithy.api#documentation": "Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.
\nIf you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. You might\n need to remove the staging label AWSPENDING from the partially created version. \n You also need to determine whether to roll back to the previous version of the secret \n by moving the staging label AWSCURRENT to the version that has AWSPENDING.\n To determine \n which version has a specific staging label, call ListSecretVersionIds. Then use \n UpdateSecretVersionStage to change staging labels. \n For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
\n\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.
\nIf you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. You might\n need to remove the staging label AWSPENDING from the partially created version. \n You also need to determine whether to roll back to the previous version of the secret \n by moving the staging label AWSCURRENT to the version that has AWSPENDING.\n To determine \n which version has a specific staging label, call ListSecretVersionIds. Then use \n UpdateSecretVersionStage to change staging labels. \n For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Creates a new secret. A secret can be a password, a set of \n credentials such as a user name and password, an OAuth token, or other secret information \n that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.
\nFor information about creating a secret in the console, see Create a secret.
\nTo create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but not both. \n If you include SecretString or SecretBinary\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,\n you must make sure the JSON you store in the SecretString matches the JSON structure of\n a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. \n Creating aws/secretsmanager can result in a one-time significant delay in returning the \n result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.
\n Required permissions: \n secretsmanager:CreateSecret. If you \n include tags in the secret, you also need secretsmanager:TagResource.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Creates a new secret. A secret can be a password, a set of \n credentials such as a user name and password, an OAuth token, or other secret information \n that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.
\nFor information about creating a secret in the console, see Create a secret.
\nTo create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but not both. \n If you include SecretString or SecretBinary\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,\n you must make sure the JSON you store in the SecretString matches the JSON structure of\n a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. \n Creating aws/secretsmanager can result in a one-time significant delay in returning the \n result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:CreateSecret. If you \n include tags in the secret, you also need secretsmanager:TagResource.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Specifies whether to overwrite a secret with the same name in the\n destination Region.
" } } @@ -294,7 +299,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.
\n\n Required permissions: \n secretsmanager:DeleteResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:DeleteResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the \n replicas using RemoveRegionsFromReplication, and then delete the primary secret. \n When you delete a replica, it is deleted immediately.
\nYou can't directly delete a version of a secret. Instead, you remove all staging labels \n from the version using UpdateSecretVersionStage. This marks the version as deprecated, \n and then Secrets Manager can automatically delete the version in the background.
\nTo determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm \n to alert you to any attempts to access a secret during the recovery window. For more information, \n see \n Monitor secrets scheduled for deletion.
\nSecrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.
\nAt any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value.\n You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
\n\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the \n replicas using RemoveRegionsFromReplication, and then delete the primary secret. \n When you delete a replica, it is deleted immediately.
\nYou can't directly delete a version of a secret. Instead, you remove all staging labels \n from the version using UpdateSecretVersionStage. This marks the version as deprecated, \n and then Secrets Manager can automatically delete the version in the background.
\nTo determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm \n to alert you to any attempts to access a secret during the recovery window. For more information, \n see \n Monitor secrets scheduled for deletion.
\nSecrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.
\nAt any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value.\n You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the\n secret. You can't use both this parameter and ForceDeleteWithoutRecovery\n in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and RecoveryWindowInDays in the same\n call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.
\nUse this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithouRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.
\n\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Specifies whether automatic rotation is turned on for this secret.
\nTo turn on rotation, use RotateSecret. To turn off\n rotation, use CancelRotateSecret.
" } }, @@ -594,16 +599,28 @@ } }, "com.amazonaws.secretsmanager#ExcludeLowercaseType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#ExcludeNumbersType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#ExcludePunctuationType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#ExcludeUppercaseType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#Filter": { "type": "structure", @@ -626,34 +643,44 @@ } }, "com.amazonaws.secretsmanager#FilterNameStringType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "description", - "name": "description" - }, - { - "value": "name", - "name": "name" - }, - { - "value": "tag-key", - "name": "tag_key" - }, - { - "value": "tag-value", - "name": "tag_value" - }, - { - "value": "primary-region", - "name": "primary_region" - }, - { - "value": "all", - "name": "all" - } - ] + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "name" + } + }, + "tag_key": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tag-key" + } + }, + "tag_value": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tag-value" + } + }, + "primary_region": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "primary-region" + } + }, + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + } } }, "com.amazonaws.secretsmanager#FilterValueStringType": { @@ -710,7 +737,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.
\n\n Required permissions: \n secretsmanager:GetRandomPassword. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:GetRandomPassword. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
The length of the password. If you don't include this parameter, the \n default length is 32 characters.
" } }, @@ -732,42 +759,42 @@ "ExcludeNumbers": { "target": "com.amazonaws.secretsmanager#ExcludeNumbersType", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Specifies whether to exclude numbers from the password. If you don't \n include this switch, the password can contain numbers.
" } }, "ExcludePunctuation": { "target": "com.amazonaws.secretsmanager#ExcludePunctuationType", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Specifies whether to exclude the following punctuation characters from the password: \n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~. \n If you don't include this switch, the password can contain punctuation.
Specifies whether to exclude uppercase letters from the password. If you \n don't include this switch, the password can contain uppercase letters.
" } }, "ExcludeLowercase": { "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Specifies whether to exclude lowercase letters from the password. If\n you don't include this switch, the password can contain lowercase letters.
" } }, "IncludeSpace": { "target": "com.amazonaws.secretsmanager#IncludeSpaceType", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Specifies whether to include the space character. If you \n include this switch, the password can contain space characters.
" } }, "RequireEachIncludedType": { "target": "com.amazonaws.secretsmanager#RequireEachIncludedTypeType", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. \n If you don't include this switch, the password contains at least one of every character type.
" } } @@ -807,7 +834,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the JSON text of the resource-based policy document attached to the\n secret. For more information about permissions policies attached to a secret, see \n Permissions \n policies attached to a secret.
\n\n Required permissions: \n secretsmanager:GetResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Retrieves the JSON text of the resource-based policy document attached to the\n secret. For more information about permissions policies attached to a secret, see \n Permissions \n policies attached to a secret.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:GetResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.
We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.
\nTo retrieve the previous version of a secret, use VersionStage and specify \n AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
\n Required permissions: \n secretsmanager:GetSecretValue. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.
We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.
\nTo retrieve the previous version of a secret, use VersionStage and specify \n AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:GetSecretValue. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions \n of a secret. For more information, see \n Secrets Manager concepts: Versions.
\nTo list the secrets in the account, use ListSecrets.
\n\n Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions \n of a secret. For more information, see \n Secrets Manager concepts: Versions.
\nTo list the secrets in the account, use ListSecrets.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
The number of results to include in the response.
\nIf there are more results available, in the response, Secrets Manager includes NextToken. \n To get the next results, call ListSecretVersionIds again with the value from NextToken.
Specifies whether to include versions of secrets that don't have any\n staging labels attached to them. Versions without staging labels are considered deprecated and are subject to\n deletion by Secrets Manager.
" } } @@ -1144,7 +1174,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
\nListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. \n To get the latest information for a specific secret, use DescribeSecret.
\nTo list the versions of a secret, use ListSecretVersionIds.
\nTo get the secret value from SecretString or SecretBinary, \n call GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
\n\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
\nListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. \n To get the latest information for a specific secret, use DescribeSecret.
\nTo list the versions of a secret, use ListSecretVersionIds.
\nTo get the secret value from SecretString or SecretBinary, \n call GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
The number of results to include in the response.
\nIf there are more results available, in the response, Secrets Manager includes NextToken. \n To get the next results, call ListSecrets again with the value from \n NextToken.
Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see Authentication and access control for Secrets Manager\n
\nFor information about attaching a policy in the console, see Attach a \n permissions policy to a secret.
\n\n Required permissions: \n secretsmanager:PutResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see Authentication and access control for Secrets Manager\n
\nFor information about attaching a policy in the console, see Attach a \n permissions policy to a secret.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:PutResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
" } } @@ -1399,7 +1431,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .
If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken \n that matches an existing version's VersionId, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.
\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it. \n If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken \n that matches an existing version's VersionId, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
\n\n Required permissions: \n secretsmanager:RemoveRegionsFromReplication. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:RemoveRegionsFromReplication. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Replicates the secret to a new Regions. See Multi-Region secrets.
\n\n Required permissions: \n secretsmanager:ReplicateSecretToRegions. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Replicates the secret to a new Regions. See Multi-Region secrets.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:ReplicateSecretToRegions. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Specifies whether to overwrite a secret with the same name in the destination Region.
" } } @@ -1697,7 +1733,10 @@ } }, "com.amazonaws.secretsmanager#RequireEachIncludedTypeType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#ResourceExistsException": { "type": "structure", @@ -1746,7 +1785,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. You can access a secret again after it has been restored.
\n Required permissions: \n secretsmanager:RestoreSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:RestoreSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Configures and starts the asynchronous process of rotating the secret. For more information about rotation, \n see Rotate secrets.
\nIf you include the\n configuration parameters, the operation sets the values for the secret and then immediately\n starts a rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret.
\nFor database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must \n make sure the secret value is in the\n JSON structure\n of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser\n secret.
\n \nTo configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule \n for the rotation. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the database or service to\n match. After testing the new credentials, the function marks the new secret version with the staging\n label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more\n information, see How rotation works.
You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose \n a template that matches your Rotation strategy.
\nWhen rotation is successful, the AWSPENDING staging label might be attached\n to the same version as the AWSCURRENT version, or it might not be attached to any\n version. If the AWSPENDING staging label is present but not attached to the same\n version as AWSCURRENT, then any later invocation of RotateSecret\n assumes that a previous rotation request is still in progress and returns an error.
\n Required permissions: \n secretsmanager:RotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. \n For more information, see \n Permissions for rotation.
Configures and starts the asynchronous process of rotating the secret. For more information about rotation, \n see Rotate secrets.
\nIf you include the\n configuration parameters, the operation sets the values for the secret and then immediately\n starts a rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret.
\nFor database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must \n make sure the secret value is in the\n JSON structure\n of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser\n secret.
\n \nTo configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule \n for the rotation. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the database or service to\n match. After testing the new credentials, the function marks the new secret version with the staging\n label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more\n information, see How rotation works.
You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose \n a template that matches your Rotation strategy.
\nWhen rotation is successful, the AWSPENDING staging label might be attached\n to the same version as the AWSCURRENT version, or it might not be attached to any\n version. If the AWSPENDING staging label is present but not attached to the same\n version as AWSCURRENT, then any later invocation of RotateSecret\n assumes that a previous rotation request is still in progress and returns an error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:RotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. \n For more information, see \n Permissions for rotation.
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. \n The rotation schedule is defined in RotateSecretRequest$RotationRules.
\nIf you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the \n \n testSecret \n step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.
" } } @@ -1866,7 +1905,10 @@ } }, "com.amazonaws.secretsmanager#RotationEnabledType": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.secretsmanager#RotationLambdaARNType": { "type": "string", @@ -1883,7 +1925,7 @@ "AutomaticallyAfterDays": { "target": "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of days between automatic scheduled rotations of the secret. You can use this \n value to check that your secret meets your compliance guidelines for how often secrets must \n be rotated.
\nIn DescribeSecret and ListSecrets, this value is calculated from \n the rotation schedule after every successful rotation. In RotateSecret, you can \n set the rotation schedule in RotationRules with AutomaticallyAfterDays\n or ScheduleExpression, but not both.
Indicates whether automatic, scheduled rotation is enabled for this secret.
" } }, @@ -2156,18 +2198,20 @@ } }, "com.amazonaws.secretsmanager#SortOrderType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "asc", - "name": "asc" - }, - { - "value": "desc", - "name": "desc" + "type": "enum", + "members": { + "asc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "asc" + } + }, + "desc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "desc" } - ] + } } }, "com.amazonaws.secretsmanager#StatusMessageType": { @@ -2180,22 +2224,26 @@ } }, "com.amazonaws.secretsmanager#StatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InSync", - "name": "InSync" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "InProgress", - "name": "InProgress" + "type": "enum", + "members": { + "InSync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InSync" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } } }, "com.amazonaws.secretsmanager#StopReplicationToReplica": { @@ -2221,7 +2269,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
\nYou must call this operation from the Region in which you want to promote the replica to a primary secret.
\n\n Required permissions: \n secretsmanager:StopReplicationToReplica. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
\nYou must call this operation from the Region in which you want to promote the replica to a primary secret.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:StopReplicationToReplica. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the \n secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
\nThe following restrictions apply to tags:
\nMaximum number of tags per secret: 50
\nMaximum key length: 127 Unicode characters in UTF-8
\nMaximum value length: 255 Unicode characters in UTF-8
\nTag keys and values are case sensitive.
\nDo not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.
\nIf you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\n\n Required permissions: \n secretsmanager:TagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the \n secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
\nThe following restrictions apply to tags:
\nMaximum number of tags per secret: 50
\nMaximum key length: 127 Unicode characters in UTF-8
\nMaximum value length: 255 Unicode characters in UTF-8
\nTag keys and values are case sensitive.
\nDo not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.
\nIf you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:TagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Removes specific tags from a secret.
\nThis operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.
\nIf you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\n\n Required permissions: \n secretsmanager:UntagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Removes specific tags from a secret.
\nThis operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.
\nIf you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:UntagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
\nTo change the rotation configuration of a secret, use RotateSecret instead.
\n \nWe recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.
If you call this operation with a ClientRequestToken that matches an existing version's \n VersionId, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.
\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
\nTo change the rotation configuration of a secret, use RotateSecret instead.
\n \nWe recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new\n version. Then it attaches the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version's \n VersionId, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to\n track a version as it progresses through the secret rotation process. Each staging label can be \n attached to only one version at a time. To add a staging label to a version when it is already \n attached to another version, Secrets Manager first removes it from the other version first and\n then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
\nThe staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this\n call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.
\n\n Required permissions: \n secretsmanager:UpdateSecretVersionStage. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to\n track a version as it progresses through the secret rotation process. Each staging label can be \n attached to only one version at a time. To add a staging label to a version when it is already \n attached to another version, Secrets Manager first removes it from the other version first and\n then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
\nThe staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this\n call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:UpdateSecretVersionStage. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.
\nThe API performs three checks when validating the policy:
\nSends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not\n allow broad access to your secret, for example policies that use a wildcard for the principal.
\nChecks for correct syntax in a policy.
\nVerifies the policy does not lock out a caller.
\n\n Required permissions: \n secretsmanager:ValidateResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.
\nThe API performs three checks when validating the policy:
\nSends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not\n allow broad access to your secret, for example policies that use a wildcard for the principal.
\nChecks for correct syntax in a policy.
\nVerifies the policy does not lock out a caller.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:ValidateResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
True if your policy passes validation, otherwise false.
" } }, @@ -2669,21 +2718,6 @@ }, "com.amazonaws.secretsmanager#secretsmanager": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Secrets Manager", - "arnNamespace": "secretsmanager", - "cloudFormationName": "SecretsManager", - "cloudTrailEventSource": "secretsmanager.amazonaws.com", - "endpointPrefix": "secretsmanager" - }, - "aws.auth#sigv4": { - "name": "secretsmanager" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
\n \nThis guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.
\n \n\n API Version\n
\n \nThis version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n Support and Feedback for Amazon Web Services Secrets Manager\n
\nWe welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.
\n \n\n Logging API Requests\n
\nAmazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", - "smithy.api#title": "AWS Secrets Manager" - }, "version": "2017-10-17", "operations": [ { @@ -2752,7 +2786,22 @@ { "target": "com.amazonaws.secretsmanager#ValidateResourcePolicy" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Secrets Manager", + "arnNamespace": "secretsmanager", + "cloudFormationName": "SecretsManager", + "cloudTrailEventSource": "secretsmanager.amazonaws.com", + "endpointPrefix": "secretsmanager" + }, + "aws.auth#sigv4": { + "name": "secretsmanager" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
\n \nThis guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.
\n \n\n API Version\n
\n \nThis version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n Support and Feedback for Amazon Web Services Secrets Manager\n
\nWe welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.
\n \n\n Logging API Requests\n
\nAmazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", + "smithy.api#title": "AWS Secrets Manager" + } } } } diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index 3933b7bfdf5..b76ba0395a8 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -127,12 +127,14 @@ "RegistrationLimit": { "target": "com.amazonaws.ssm#RegistrationLimit", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of managed nodes that can be registered using this activation.
" } }, "RegistrationsCount": { "target": "com.amazonaws.ssm#RegistrationsCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of managed nodes already registered with this activation.
" } }, @@ -145,6 +147,7 @@ "Expired": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether or not the activation is expired.
" } }, @@ -264,7 +267,103 @@ } }, "com.amazonaws.ssm#AggregatorSchemaOnly": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ssm#Alarm": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#AlarmName", + "traits": { + "smithy.api#documentation": "The name of your CloudWatch alarm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A CloudWatch alarm you apply to an automation or command.
" + } + }, + "com.amazonaws.ssm#AlarmConfiguration": { + "type": "structure", + "members": { + "IgnorePollAlarmFailure": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "If you specify true for this value, your automation or command continue to run even if we can't gather information about the state of your CloudWatch alarm. The default value is false.
The name of the CloudWatch alarm specified in the configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm you want to apply to an automation or command.
" + } + }, + "com.amazonaws.ssm#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#Alarm" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.ssm#AlarmName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.ssm#AlarmStateInformation": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#AlarmName", + "traits": { + "smithy.api#documentation": "The name of your CloudWatch alarm.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.ssm#ExternalAlarmState", + "traits": { + "smithy.api#documentation": "The state of your CloudWatch alarm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details about the state of your CloudWatch alarm.
" + } + }, + "com.amazonaws.ssm#AlarmStateInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#AlarmStateInformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } }, "com.amazonaws.ssm#AllowedPattern": { "type": "string", @@ -293,24 +392,6 @@ }, "com.amazonaws.ssm#AmazonSSM": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "SSM", - "arnNamespace": "ssm", - "cloudFormationName": "SSM", - "cloudTrailEventSource": "ssm.amazonaws.com", - "endpointPrefix": "ssm" - }, - "aws.auth#sigv4": { - "name": "ssm" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and\n infrastructure running in the Amazon Web Services Cloud;. Systems Manager simplifies application and resource management,\n shortens the time to detect and resolve operational problems, and helps you manage your Amazon Web Services\n resources securely at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
\nTo get started, verify prerequisites. For more information, see Setting up\n Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about how to use a Query API, see Making API requests.
\nFor information about other API operations you can perform on EC2 instances, see the\n Amazon EC2 API Reference.
\nFor information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API\n Reference.
\nFor information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide\n and the Incident Manager API\n Reference.
\nAmazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and\n infrastructure running in the Amazon Web Services Cloud;. Systems Manager simplifies application and resource management,\n shortens the time to detect and resolve operational problems, and helps you manage your Amazon Web Services\n resources securely at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
\nTo get started, verify prerequisites. For more information, see Setting up\n Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about how to use a Query API, see Making API requests.
\nFor information about other API operations you can perform on EC2 instances, see the\n Amazon EC2 API Reference.
\nFor information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API\n Reference.
\nFor information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide\n and the Incident Manager API\n Reference.
\nNumber of days to wait after the scheduled day to run an association.
" } }, @@ -911,30 +1014,38 @@ } }, "com.amazonaws.ssm#AssociationComplianceSeverity": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "Critical" - }, - { - "value": "HIGH", - "name": "High" - }, - { - "value": "MEDIUM", - "name": "Medium" - }, - { - "value": "LOW", - "name": "Low" - }, - { - "value": "UNSPECIFIED", - "name": "Unspecified" - } - ] + "type": "enum", + "members": { + "Critical": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + }, + "High": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "Medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "Low": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "Unspecified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + } } }, "com.amazonaws.ssm#AssociationDescription": { @@ -1069,6 +1180,7 @@ "ApplyOnlyAtCronInterval": { "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter isn't supported for rate\n expressions.
" } }, @@ -1087,7 +1199,7 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#ScheduleOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, @@ -1096,6 +1208,15 @@ "traits": { "smithy.api#documentation": "A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration" + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarm that was invoked during the association.
" + } } }, "traits": { @@ -1177,6 +1298,15 @@ "traits": { "smithy.api#documentation": "An aggregate status of the resources in the execution based on the status type.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration" + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarms that were invoked by the association.
" + } } }, "traits": { @@ -1229,22 +1359,26 @@ } }, "com.amazonaws.ssm#AssociationExecutionFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ExecutionId", - "name": "ExecutionId" - }, - { - "value": "Status", - "name": "Status" - }, - { - "value": "CreatedTime", - "name": "CreatedTime" + "type": "enum", + "members": { + "ExecutionId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionId" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CreatedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedTime" } - ] + } } }, "com.amazonaws.ssm#AssociationExecutionFilterList": { @@ -1360,22 +1494,26 @@ } }, "com.amazonaws.ssm#AssociationExecutionTargetsFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Status", - "name": "Status" - }, - { - "value": "ResourceId", - "name": "ResourceId" - }, - { - "value": "ResourceType", - "name": "ResourceType" + "type": "enum", + "members": { + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "ResourceId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceId" } - ] + }, + "ResourceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + } } }, "com.amazonaws.ssm#AssociationExecutionTargetsFilterList": { @@ -1441,42 +1579,56 @@ } }, "com.amazonaws.ssm#AssociationFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InstanceId", - "name": "InstanceId" - }, - { - "value": "Name", - "name": "Name" - }, - { - "value": "AssociationId", - "name": "AssociationId" - }, - { - "value": "AssociationStatusName", - "name": "Status" - }, - { - "value": "LastExecutedBefore", - "name": "LastExecutedBefore" - }, - { - "value": "LastExecutedAfter", - "name": "LastExecutedAfter" - }, - { - "value": "AssociationName", - "name": "AssociationName" - }, - { - "value": "ResourceGroupName", - "name": "ResourceGroupName" - } - ] + "type": "enum", + "members": { + "InstanceId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceId" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "AssociationId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationId" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationStatusName" + } + }, + "LastExecutedBefore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastExecutedBefore" + } + }, + "LastExecutedAfter": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastExecutedAfter" + } + }, + "AssociationName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationName" + } + }, + "ResourceGroupName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceGroupName" + } + } } }, "com.amazonaws.ssm#AssociationFilterList": { @@ -1494,22 +1646,26 @@ } }, "com.amazonaws.ssm#AssociationFilterOperatorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUAL", - "name": "Equal" - }, - { - "value": "LESS_THAN", - "name": "LessThan" - }, - { - "value": "GREATER_THAN", - "name": "GreaterThan" + "type": "enum", + "members": { + "Equal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUAL" + } + }, + "LessThan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" } - ] + }, + "GreaterThan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + } } }, "com.amazonaws.ssm#AssociationFilterValue": { @@ -1654,37 +1810,43 @@ } }, "com.amazonaws.ssm#AssociationStatusName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "Pending" - }, - { - "value": "Success", - "name": "Success" - }, - { - "value": "Failed", - "name": "Failed" + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + } } }, "com.amazonaws.ssm#AssociationSyncCompliance": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTO", - "name": "Auto" - }, - { - "value": "MANUAL", - "name": "Manual" + "type": "enum", + "members": { + "Auto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" } - ] + }, + "Manual": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } } }, "com.amazonaws.ssm#AssociationVersion": { @@ -1783,6 +1945,7 @@ "ApplyOnlyAtCronInterval": { "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter isn't supported for rate\n expressions.
" } }, @@ -1801,7 +1964,7 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#ScheduleOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, @@ -1855,6 +2018,7 @@ "Size": { "target": "com.amazonaws.ssm#ContentLength", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size of an attachment in bytes.
" } }, @@ -1900,14 +2064,14 @@ } }, "com.amazonaws.ssm#AttachmentHashType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Sha256", - "name": "SHA256" + "type": "enum", + "members": { + "SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sha256" } - ] + } } }, "com.amazonaws.ssm#AttachmentIdentifier": { @@ -1975,22 +2139,26 @@ } }, "com.amazonaws.ssm#AttachmentsSourceKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SourceUrl", - "name": "SourceUrl" - }, - { - "value": "S3FileUrl", - "name": "S3FileUrl" - }, - { - "value": "AttachmentReference", - "name": "AttachmentReference" + "type": "enum", + "members": { + "SourceUrl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SourceUrl" + } + }, + "S3FileUrl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3FileUrl" } - ] + }, + "AttachmentReference": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachmentReference" + } + } } }, "com.amazonaws.ssm#AttachmentsSourceList": { @@ -2146,6 +2314,7 @@ "StepExecutionsTruncated": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A boolean value that indicates if the response contains the full list of the Automation step\n executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list\n of step executions.
" } }, @@ -2251,6 +2420,18 @@ "smithy.api#documentation": "An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a\n multi-Region and multi-account Automation execution.
" } }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm applied to your automation.
" + } + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarm that was invoked by the automation.
" + } + }, "AutomationSubtype": { "target": "com.amazonaws.ssm#AutomationSubtype", "traits": { @@ -2315,62 +2496,84 @@ } }, "com.amazonaws.ssm#AutomationExecutionFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DocumentNamePrefix", - "name": "DOCUMENT_NAME_PREFIX" - }, - { - "value": "ExecutionStatus", - "name": "EXECUTION_STATUS" - }, - { - "value": "ExecutionId", - "name": "EXECUTION_ID" - }, - { - "value": "ParentExecutionId", - "name": "PARENT_EXECUTION_ID" - }, - { - "value": "CurrentAction", - "name": "CURRENT_ACTION" - }, - { - "value": "StartTimeBefore", - "name": "START_TIME_BEFORE" - }, - { - "value": "StartTimeAfter", - "name": "START_TIME_AFTER" - }, - { - "value": "AutomationType", - "name": "AUTOMATION_TYPE" - }, - { - "value": "TagKey", - "name": "TAG_KEY" - }, - { - "value": "TargetResourceGroup", - "name": "TARGET_RESOURCE_GROUP" - }, - { - "value": "AutomationSubtype", - "name": "AUTOMATION_SUBTYPE" - }, - { - "value": "OpsItemId", - "name": "OPS_ITEM_ID" - } - ] - } - }, - "com.amazonaws.ssm#AutomationExecutionFilterList": { - "type": "list", + "type": "enum", + "members": { + "DOCUMENT_NAME_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DocumentNamePrefix" + } + }, + "EXECUTION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionStatus" + } + }, + "EXECUTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionId" + } + }, + "PARENT_EXECUTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentExecutionId" + } + }, + "CURRENT_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentAction" + } + }, + "START_TIME_BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTimeBefore" + } + }, + "START_TIME_AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTimeAfter" + } + }, + "AUTOMATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutomationType" + } + }, + "TAG_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TagKey" + } + }, + "TARGET_RESOURCE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TargetResourceGroup" + } + }, + "AUTOMATION_SUBTYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutomationSubtype" + } + }, + "OPS_ITEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpsItemId" + } + } + } + }, + "com.amazonaws.ssm#AutomationExecutionFilterList": { + "type": "list", "member": { "target": "com.amazonaws.ssm#AutomationExecutionFilter" }, @@ -2562,6 +2765,18 @@ "smithy.api#documentation": "Use this filter with DescribeAutomationExecutions. Specify either Local or\n CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and\n Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the\n Amazon Web Services Systems Manager User Guide.
" } }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm applied to your automation.
" + } + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarm that was invoked by the automation.
" + } + }, "AutomationSubtype": { "target": "com.amazonaws.ssm#AutomationSubtype", "traits": { @@ -2626,82 +2841,116 @@ } }, "com.amazonaws.ssm#AutomationExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "INPROGRESS" - }, - { - "value": "Waiting", - "name": "WAITING" - }, - { - "value": "Success", - "name": "SUCCESS" - }, - { - "value": "TimedOut", - "name": "TIMEDOUT" - }, - { - "value": "Cancelling", - "name": "CANCELLING" - }, - { - "value": "Cancelled", - "name": "CANCELLED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "PendingApproval", - "name": "PENDING_APPROVAL" - }, - { - "value": "Approved", - "name": "APPROVED" - }, - { - "value": "Rejected", - "name": "REJECTED" - }, - { - "value": "Scheduled", - "name": "SCHEDULED" - }, - { - "value": "RunbookInProgress", - "name": "RUNBOOK_INPROGRESS" - }, - { - "value": "PendingChangeCalendarOverride", - "name": "PENDING_CHANGE_CALENDAR_OVERRIDE" - }, - { - "value": "ChangeCalendarOverrideApproved", - "name": "CHANGE_CALENDAR_OVERRIDE_APPROVED" - }, - { - "value": "ChangeCalendarOverrideRejected", - "name": "CHANGE_CALENDAR_OVERRIDE_REJECTED" - }, - { - "value": "CompletedWithSuccess", - "name": "COMPLETED_WITH_SUCCESS" - }, - { - "value": "CompletedWithFailure", - "name": "COMPLETED_WITH_FAILURE" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "WAITING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Waiting" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "TIMEDOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimedOut" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelling" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingApproval" + } + }, + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "RUNBOOK_INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RunbookInProgress" + } + }, + "PENDING_CHANGE_CALENDAR_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingChangeCalendarOverride" + } + }, + "CHANGE_CALENDAR_OVERRIDE_APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeCalendarOverrideApproved" + } + }, + "CHANGE_CALENDAR_OVERRIDE_REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeCalendarOverrideRejected" + } + }, + "COMPLETED_WITH_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithSuccess" + } + }, + "COMPLETED_WITH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithFailure" + } + } } }, "com.amazonaws.ssm#AutomationParameterKey": { @@ -2766,14 +3015,14 @@ } }, "com.amazonaws.ssm#AutomationSubtype": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ChangeRequest", - "name": "ChangeRequest" + "type": "enum", + "members": { + "ChangeRequest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequest" } - ] + } } }, "com.amazonaws.ssm#AutomationTargetParameterName": { @@ -2786,18 +3035,20 @@ } }, "com.amazonaws.ssm#AutomationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CrossAccount", - "name": "CrossAccount" - }, - { - "value": "Local", - "name": "Local" + "type": "enum", + "members": { + "CrossAccount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CrossAccount" + } + }, + "Local": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Local" } - ] + } } }, "com.amazonaws.ssm#BaselineDescription": { @@ -2871,6 +3122,7 @@ "ApprovedPatchesEnableNonSecurity": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Enables Systems Manager to send command output to CloudWatch Logs.
" } } @@ -3102,7 +3360,10 @@ } }, "com.amazonaws.ssm#CloudWatchOutputEnabled": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#Command": { "type": "structure", @@ -3206,24 +3467,28 @@ "TargetCount": { "target": "com.amazonaws.ssm#TargetCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of targets for the command.
" } }, "CompletedCount": { "target": "com.amazonaws.ssm#CompletedCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of targets for which the command invocation reached a terminal state. Terminal\n states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out,\n Cancelled, Terminated, or Undeliverable.
" } }, "ErrorCount": { "target": "com.amazonaws.ssm#ErrorCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of targets for which the status is Failed or Execution Timed Out.
" } }, "DeliveryTimedOutCount": { "target": "com.amazonaws.ssm#DeliveryTimedOutCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of targets for which the status is Delivery Timed Out.
" } }, @@ -3248,8 +3513,21 @@ "TimeoutSeconds": { "target": "com.amazonaws.ssm#TimeoutSeconds", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The TimeoutSeconds value specified for a command.
The details for the CloudWatch alarm applied to your command.
" + } + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarm that was invoked by the command.
" + } } }, "traits": { @@ -3279,30 +3557,38 @@ } }, "com.amazonaws.ssm#CommandFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InvokedAfter", - "name": "INVOKED_AFTER" - }, - { - "value": "InvokedBefore", - "name": "INVOKED_BEFORE" - }, - { - "value": "Status", - "name": "STATUS" - }, - { - "value": "ExecutionStage", - "name": "EXECUTION_STAGE" - }, - { - "value": "DocumentName", - "name": "DOCUMENT_NAME" - } - ] + "type": "enum", + "members": { + "INVOKED_AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvokedAfter" + } + }, + "INVOKED_BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvokedBefore" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "EXECUTION_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionStage" + } + }, + "DOCUMENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DocumentName" + } + } } }, "com.amazonaws.ssm#CommandFilterList": { @@ -3446,42 +3732,56 @@ } }, "com.amazonaws.ssm#CommandInvocationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Delayed", - "name": "DELAYED" - }, - { - "value": "Success", - "name": "SUCCESS" - }, - { - "value": "Cancelled", - "name": "CANCELLED" - }, - { - "value": "TimedOut", - "name": "TIMED_OUT" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Cancelling", - "name": "CANCELLING" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "DELAYED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delayed" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimedOut" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelling" + } + } } }, "com.amazonaws.ssm#CommandList": { @@ -3493,6 +3793,7 @@ "com.amazonaws.ssm#CommandMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -3523,6 +3824,7 @@ "ResponseCode": { "target": "com.amazonaws.ssm#ResponseCode", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A numeric response code generated after running the plugin.
" } }, @@ -3603,69 +3905,91 @@ } }, "com.amazonaws.ssm#CommandPluginStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Success", - "name": "SUCCESS" - }, - { - "value": "TimedOut", - "name": "TIMED_OUT" - }, - { - "value": "Cancelled", - "name": "CANCELLED" - }, - { - "value": "Failed", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimedOut" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.ssm#CommandStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Success", - "name": "SUCCESS" - }, - { - "value": "Cancelled", - "name": "CANCELLED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "TimedOut", - "name": "TIMED_OUT" - }, - { - "value": "Cancelling", - "name": "CANCELLING" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimedOut" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelling" + } + } } }, "com.amazonaws.ssm#Comment": { @@ -3678,7 +4002,10 @@ } }, "com.amazonaws.ssm#CompletedCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#ComplianceExecutionId": { "type": "string", @@ -3882,30 +4209,38 @@ } }, "com.amazonaws.ssm#ComplianceQueryOperatorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUAL", - "name": "Equal" - }, - { - "value": "NOT_EQUAL", - "name": "NotEqual" - }, - { - "value": "BEGIN_WITH", - "name": "BeginWith" - }, - { - "value": "LESS_THAN", - "name": "LessThan" - }, - { - "value": "GREATER_THAN", - "name": "GreaterThan" - } - ] + "type": "enum", + "members": { + "Equal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUAL" + } + }, + "NotEqual": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUAL" + } + }, + "BeginWith": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGIN_WITH" + } + }, + "LessThan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "GreaterThan": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + } } }, "com.amazonaws.ssm#ComplianceResourceId": { @@ -3949,50 +4284,62 @@ } }, "com.amazonaws.ssm#ComplianceSeverity": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "Critical" - }, - { - "value": "HIGH", - "name": "High" - }, - { - "value": "MEDIUM", - "name": "Medium" - }, - { - "value": "LOW", - "name": "Low" - }, - { - "value": "INFORMATIONAL", - "name": "Informational" - }, - { - "value": "UNSPECIFIED", - "name": "Unspecified" - } - ] - } - }, - "com.amazonaws.ssm#ComplianceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPLIANT", - "name": "Compliant" - }, - { - "value": "NON_COMPLIANT", - "name": "NonCompliant" + "type": "enum", + "members": { + "Critical": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" } - ] - } + }, + "High": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "Medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "Low": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "Informational": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFORMATIONAL" + } + }, + "Unspecified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + } + } + }, + "com.amazonaws.ssm#ComplianceStatus": { + "type": "enum", + "members": { + "Compliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIANT" + } + }, + "NonCompliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_COMPLIANT" + } + } + } }, "com.amazonaws.ssm#ComplianceStringFilter": { "type": "structure", @@ -4054,7 +4401,10 @@ } }, "com.amazonaws.ssm#ComplianceSummaryCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#ComplianceSummaryItem": { "type": "structure", @@ -4118,18 +4468,20 @@ } }, "com.amazonaws.ssm#ComplianceUploadType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPLETE", - "name": "Complete" - }, - { - "value": "PARTIAL", - "name": "Partial" + "type": "enum", + "members": { + "Complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "Partial": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL" } - ] + } } }, "com.amazonaws.ssm#CompliantSummary": { @@ -4138,6 +4490,7 @@ "CompliantCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of resources that are compliant.
" } }, @@ -4162,22 +4515,27 @@ } }, "com.amazonaws.ssm#ConnectionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Connected", - "name": "CONNECTED" - }, - { - "value": "NotConnected", - "name": "NOT_CONNECTED" + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Connected" + } + }, + "NOT_CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotConnected" } - ] + } } }, "com.amazonaws.ssm#ContentLength": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#CreateActivation": { "type": "operation", @@ -4224,7 +4582,7 @@ "RegistrationLimit": { "target": "com.amazonaws.ssm#RegistrationLimit", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Specify the maximum number of managed nodes you want to register. The default value is\n 1.
By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter isn't supported for rate\n expressions.
" } }, @@ -4497,7 +4856,7 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#ScheduleOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association.
" } }, @@ -4506,6 +4865,9 @@ "traits": { "smithy.api#documentation": "A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration" } }, "traits": { @@ -4614,6 +4976,7 @@ "ApplyOnlyAtCronInterval": { "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "By default, when you create a new association, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter isn't supported for rate\n expressions.
" } }, @@ -4632,7 +4995,7 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#ScheduleOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.
Adds or overwrites one or more tags for a State Manager association. Tags\n are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your\n resources in different ways, for example, by purpose, owner, or environment. Each tag consists of\n a key and an optional value, both of which you define.
" + "smithy.api#documentation": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag an association to identify the type of resource to which it applies, the environment, or the purpose of the association.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration" } } }, @@ -4838,13 +5204,14 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of days to wait after the date and time specified by a cron expression before\n running the maintenance window.
\nFor example, the following cron expression schedules a maintenance window to run on the\n third Tuesday of every month at 11:30 PM.
\n\n cron(30 23 ? * TUE#3 *)\n
If the schedule offset is 2, the maintenance window won't run until two days\n later.
The duration of the maintenance window in hours.
", "smithy.api#required": {} } @@ -4852,6 +5219,7 @@ "Cutoff": { "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling\n new tasks for execution.
", "smithy.api#required": {} } @@ -4859,6 +5227,7 @@ "AllowUnassociatedTargets": { "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Enables a maintenance window task to run on managed nodes, even if you haven't registered\n those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node\n ID) when you register a task with the maintenance window.
\nIf you don't enable this option, then you must specify previously-registered targets when\n you register a task with the maintenance window.
", "smithy.api#required": {} } @@ -5154,7 +5523,7 @@ "ApprovedPatchesEnableNonSecurity": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Some SSM document types require that you specify a Force flag before you can\n delete the document. For example, you must specify a Force flag to delete a document\n of type ApplicationConfigurationSchema. You can restrict access to the\n Force flag in an Identity and Access Management (IAM) policy.
Use this option to view a summary of the deletion request without deleting any data or the\n data type. This option is useful when you only want to understand what will be deleted. Once you\n validate that the data to be deleted is what you intend to delete, you can run the same command\n without specifying the DryRun option.
The system checks if the target is being referenced by a task. If the target is being\n referenced, the system returns an error and doesn't deregister the target from the maintenance\n window.
" } } @@ -6060,22 +6437,26 @@ } }, "com.amazonaws.ssm#DescribeActivationsFilterKeys": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ActivationIds", - "name": "ACTIVATION_IDS" - }, - { - "value": "DefaultInstanceName", - "name": "DEFAULT_INSTANCE_NAME" - }, - { - "value": "IamRole", - "name": "IAM_ROLE" + "type": "enum", + "members": { + "ACTIVATION_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivationIds" + } + }, + "DEFAULT_INSTANCE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DefaultInstanceName" + } + }, + "IAM_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamRole" } - ] + } } }, "com.amazonaws.ssm#DescribeActivationsFilterList": { @@ -6096,7 +6477,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6212,7 +6593,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6289,7 +6670,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6402,7 +6783,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6491,14 +6872,14 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, "ReverseOrder": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates whether to list step executions in reverse order by start time. The default value\n is 'false'.
" } } @@ -6556,7 +6937,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#PatchBaselineMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of patches to return (per page).
" } }, @@ -6657,7 +7038,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#DocumentPermissionMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6769,7 +7150,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#EffectiveInstanceAssociationMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6843,7 +7224,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#PatchBaselineMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of patches to return (per page).
" } }, @@ -6914,7 +7295,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -6996,7 +7377,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResultsEC2Compatible", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7105,7 +7486,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#PatchComplianceMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of patches to return (per page).
" } } @@ -7147,7 +7528,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#PatchComplianceMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of managed nodes to return (per page).
" } } @@ -7227,7 +7608,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#PatchComplianceMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of patches to return (per page).
" } } @@ -7297,7 +7678,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -7372,7 +7753,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7446,7 +7827,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7517,7 +7898,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7602,7 +7983,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7676,7 +8057,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7750,7 +8131,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7845,7 +8226,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -7886,7 +8267,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -8030,7 +8411,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -8094,7 +8475,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#PatchBaselineMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of patch baselines to return (per page).
" } }, @@ -8161,78 +8542,84 @@ "Instances": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of managed nodes in the patch group.
" } }, "InstancesWithInstalledPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of managed nodes with installed patches.
" } }, "InstancesWithInstalledOtherPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of managed nodes with patches installed that aren't defined in the patch\n baseline.
" } }, "InstancesWithInstalledPendingRebootPatches": { "target": "com.amazonaws.ssm#InstancesCount", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of managed nodes with patches installed by Patch Manager that haven't been\n rebooted after the patch installation. The status of these managed nodes is\n NON_COMPLIANT.
The number of managed nodes with patches installed that are specified in a\n RejectedPatches list. Patches with a status of INSTALLED_REJECTED were\n typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of\n InstancesWithInstalledRejectedPatches will always be 0 (zero).
The number of managed nodes with missing patches from the patch baseline.
" } }, "InstancesWithFailedPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of managed nodes with patches from the patch baseline that failed to\n install.
" } }, "InstancesWithNotApplicablePatches": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of managed nodes with patches that aren't applicable.
" } }, "InstancesWithUnreportedNotApplicablePatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of managed nodes with NotApplicable patches beyond the supported\n limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
The number of managed nodes where patches that are specified as Critical for\n compliance reporting in the patch baseline aren't installed. These patches might be missing, have\n failed installation, were rejected, or were installed but awaiting a required managed node\n reboot. The status of these managed nodes is NON_COMPLIANT.
The number of managed nodes where patches that are specified as Security in a\n patch advisory aren't installed. These patches might be missing, have failed installation, were\n rejected, or were installed but awaiting a required managed node reboot. The status of these\n managed nodes is NON_COMPLIANT.
The number of managed nodes with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these managed nodes is NON_COMPLIANT.
The maximum number of patch groups to return (per page).
" } }, @@ -8351,7 +8738,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -8422,7 +8809,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#SessionMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -8789,26 +9176,32 @@ } }, "com.amazonaws.ssm#DocumentFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "Name" - }, - { - "value": "Owner", - "name": "Owner" - }, - { - "value": "PlatformTypes", - "name": "PlatformTypes" - }, - { - "value": "DocumentType", - "name": "DocumentType" - } - ] + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "Owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Owner" + } + }, + "PlatformTypes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlatformTypes" + } + }, + "DocumentType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DocumentType" + } + } } }, "com.amazonaws.ssm#DocumentFilterList": { @@ -8834,22 +9227,26 @@ } }, "com.amazonaws.ssm#DocumentFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "YAML", - "name": "YAML" - }, - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "TEXT", - "name": "TEXT" + "type": "enum", + "members": { + "YAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YAML" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" } - ] + }, + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + } } }, "com.amazonaws.ssm#DocumentHash": { @@ -8862,18 +9259,20 @@ } }, "com.amazonaws.ssm#DocumentHashType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Sha256", - "name": "SHA256" - }, - { - "value": "Sha1", - "name": "SHA1" + "type": "enum", + "members": { + "SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sha256" } - ] + }, + "SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sha1" + } + } } }, "com.amazonaws.ssm#DocumentIdentifier": { @@ -9056,14 +9455,14 @@ } }, "com.amazonaws.ssm#DocumentMetadataEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DocumentReviews", - "name": "DocumentReviews" + "type": "enum", + "members": { + "DocumentReviews": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DocumentReviews" } - ] + } } }, "com.amazonaws.ssm#DocumentMetadataResponseInfo": { @@ -9140,18 +9539,20 @@ "type": "string" }, "com.amazonaws.ssm#DocumentParameterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "String", - "name": "String" - }, - { - "value": "StringList", - "name": "StringList" + "type": "enum", + "members": { + "String": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "StringList": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringList" } - ] + } } }, "com.amazonaws.ssm#DocumentPermissionLimit": { @@ -9173,6 +9574,7 @@ "com.amazonaws.ssm#DocumentPermissionMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 200 @@ -9180,14 +9582,14 @@ } }, "com.amazonaws.ssm#DocumentPermissionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Share", - "name": "SHARE" + "type": "enum", + "members": { + "SHARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Share" } - ] + } } }, "com.amazonaws.ssm#DocumentRequires": { @@ -9223,26 +9625,32 @@ } }, "com.amazonaws.ssm#DocumentReviewAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SendForReview", - "name": "SendForReview" - }, - { - "value": "UpdateReview", - "name": "UpdateReview" - }, - { - "value": "Approve", - "name": "Approve" - }, - { - "value": "Reject", - "name": "Reject" - } - ] + "type": "enum", + "members": { + "SendForReview": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SendForReview" + } + }, + "UpdateReview": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateReview" + } + }, + "Approve": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approve" + } + }, + "Reject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Reject" + } + } } }, "com.amazonaws.ssm#DocumentReviewComment": { @@ -9288,14 +9696,14 @@ } }, "com.amazonaws.ssm#DocumentReviewCommentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Comment", - "name": "Comment" + "type": "enum", + "members": { + "Comment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Comment" } - ] + } } }, "com.amazonaws.ssm#DocumentReviewerResponseList": { @@ -9373,89 +9781,133 @@ "type": "string" }, "com.amazonaws.ssm#DocumentStatus": { - "type": "string", + "type": "enum", + "members": { + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + }, "traits": { - "smithy.api#documentation": "The status of a document.
", - "smithy.api#enum": [ - { - "value": "Creating", - "name": "Creating" - }, - { - "value": "Active", - "name": "Active" - }, - { - "value": "Updating", - "name": "Updating" - }, - { - "value": "Deleting", - "name": "Deleting" - }, - { - "value": "Failed", - "name": "Failed" - } - ] + "smithy.api#documentation": "The status of a document.
" } }, "com.amazonaws.ssm#DocumentStatusInformation": { "type": "string" }, "com.amazonaws.ssm#DocumentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Command", - "name": "Command" - }, - { - "value": "Policy", - "name": "Policy" - }, - { - "value": "Automation", - "name": "Automation" - }, - { - "value": "Session", - "name": "Session" - }, - { - "value": "Package", - "name": "Package" - }, - { - "value": "ApplicationConfiguration", - "name": "ApplicationConfiguration" - }, - { - "value": "ApplicationConfigurationSchema", - "name": "ApplicationConfigurationSchema" - }, - { - "value": "DeploymentStrategy", - "name": "DeploymentStrategy" - }, - { - "value": "ChangeCalendar", - "name": "ChangeCalendar" - }, - { - "value": "Automation.ChangeTemplate", - "name": "ChangeTemplate" - }, - { - "value": "ProblemAnalysis", - "name": "ProblemAnalysis" - }, - { - "value": "ProblemAnalysisTemplate", - "name": "ProblemAnalysisTemplate" - } - ] + "type": "enum", + "members": { + "Command": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Command" + } + }, + "Policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policy" + } + }, + "Automation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automation" + } + }, + "Session": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Session" + } + }, + "Package": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Package" + } + }, + "ApplicationConfiguration": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApplicationConfiguration" + } + }, + "ApplicationConfigurationSchema": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApplicationConfigurationSchema" + } + }, + "DeploymentStrategy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentStrategy" + } + }, + "ChangeCalendar": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeCalendar" + } + }, + "ChangeTemplate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automation.ChangeTemplate" + } + }, + "ProblemAnalysis": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProblemAnalysis" + } + }, + "ProblemAnalysisTemplate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProblemAnalysisTemplate" + } + }, + "CloudFormation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormation" + } + }, + "ConformancePackTemplate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConformancePackTemplate" + } + } } }, "com.amazonaws.ssm#DocumentVersion": { @@ -9500,6 +9952,7 @@ "IsDefaultVersion": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "An identifier for the default version of the document.
" } }, @@ -9588,7 +10041,10 @@ } }, "com.amazonaws.ssm#DryRun": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#DuplicateDocumentContent": { "type": "structure", @@ -9637,6 +10093,7 @@ "com.amazonaws.ssm#EffectiveInstanceAssociationMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 5 @@ -9670,21 +10127,26 @@ } }, "com.amazonaws.ssm#ErrorCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#ExecutionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Auto", - "name": "Auto" - }, - { - "value": "Interactive", - "name": "Interactive" + "type": "enum", + "members": { + "Auto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + }, + "Interactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interactive" } - ] + } } }, "com.amazonaws.ssm#ExecutionRoleName": { @@ -9700,6 +10162,23 @@ "com.amazonaws.ssm#ExpirationDate": { "type": "timestamp" }, + "com.amazonaws.ssm#ExternalAlarmState": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALARM" + } + } + } + }, "com.amazonaws.ssm#FailedCreateAssociation": { "type": "structure", "members": { @@ -9762,22 +10241,26 @@ } }, "com.amazonaws.ssm#Fault": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Client", - "name": "Client" - }, - { - "value": "Server", - "name": "Server" - }, - { - "value": "Unknown", - "name": "Unknown" + "type": "enum", + "members": { + "Client": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Client" + } + }, + "Server": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Server" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" } - ] + } } }, "com.amazonaws.ssm#FeatureNotAvailableException": { @@ -10095,6 +10578,7 @@ "ResponseCode": { "target": "com.amazonaws.ssm#ResponseCode", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The error level response code for the plugin script. If the response code is\n -1, then the command hasn't started running on the managed node, or it wasn't\n received by the node.
The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -10590,6 +11074,7 @@ "com.amazonaws.ssm#GetInventorySchemaMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 50, "max": 200 @@ -10614,20 +11099,21 @@ "MaxResults": { "target": "com.amazonaws.ssm#GetInventorySchemaMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, "Aggregator": { "target": "com.amazonaws.ssm#AggregatorSchemaOnly", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Returns inventory schemas that support aggregation. For example, this call returns the\n AWS:InstanceInformation type, because it supports aggregation based on the\n PlatformName, PlatformType, and PlatformVersion\n attributes.
Returns the sub-type schema for a specified inventory type.
" } } @@ -10947,6 +11433,7 @@ "Priority": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The priority of the task.
" } }, @@ -10985,6 +11472,18 @@ "traits": { "smithy.api#documentation": "The time the task execution completed.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm you applied to your maintenance window task.
" + } + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarms that were invoked by the maintenance window task.
" + } } } }, @@ -11048,7 +11547,7 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of days to wait to run a maintenance window after the scheduled cron expression\n date and time.
" } }, @@ -11061,24 +11560,28 @@ "Duration": { "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration of the maintenance window in hours.
" } }, "Cutoff": { "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling\n new tasks for execution.
" } }, "AllowUnassociatedTargets": { "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.
" } }, "Enabled": { "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the maintenance window is enabled.
" } }, @@ -11189,6 +11692,7 @@ "Priority": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The priority of the task when it runs. The lower the number, the higher the priority. Tasks\n that have the same priority are scheduled in parallel.
" } }, @@ -11227,6 +11731,12 @@ "traits": { "smithy.api#documentation": "The action to take on tasks when the maintenance window cutoff time is reached.\n CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently\n running task invocations continue, but no new task invocations are started. For Run Command\n tasks, CANCEL_TASK means the system attempts to stop the task by sending a\n CancelCommand operation.
The details for the CloudWatch alarm you applied to your maintenance window task.
" + } } } }, @@ -11299,6 +11809,7 @@ "com.amazonaws.ssm#GetOpsMetadataMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 10 @@ -11318,7 +11829,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#GetOpsMetadataMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -11427,7 +11938,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -11520,14 +12031,14 @@ "WithDecryption": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Return decrypted values for secure string parameters. This flag is ignored for\n String and StringList parameter types.
The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -11569,7 +12080,7 @@ "WithDecryption": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Return decrypted values for secure string parameters. This flag is ignored for\n String and StringList parameter types.
Retrieve all parameters within a hierarchy.
\nIf a user has access to a path, then the user can access all levels of that path. For\n example, if a user has permission to access path /a, then the user can also access\n /a/b. Even if a user has explicitly been denied access in IAM for\n parameter /a/b, they can still call the GetParametersByPath API operation\n recursively for /a and view /a/b.
Retrieve all parameters in a hierarchy with their value decrypted.
" } }, "MaxResults": { "target": "com.amazonaws.ssm#GetParametersByPathMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -11727,7 +12239,7 @@ "WithDecryption": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Return decrypted secure string value. Return decrypted values for secure string parameters.\n This flag is ignored for String and StringList parameter types.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Indicates whether the latest version of SSM Agent is running on your Linux managed node. This\n field doesn't indicate whether or not the latest version is installed on Windows managed nodes,\n because some older versions of Windows Server use the EC2Config service to process Systems Manager\n requests.
" } }, @@ -12468,42 +12983,56 @@ } }, "com.amazonaws.ssm#InstanceInformationFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InstanceIds", - "name": "INSTANCE_IDS" - }, - { - "value": "AgentVersion", - "name": "AGENT_VERSION" - }, - { - "value": "PingStatus", - "name": "PING_STATUS" - }, - { - "value": "PlatformTypes", - "name": "PLATFORM_TYPES" - }, - { - "value": "ActivationIds", - "name": "ACTIVATION_IDS" - }, - { - "value": "IamRole", - "name": "IAM_ROLE" - }, - { - "value": "ResourceType", - "name": "RESOURCE_TYPE" - }, - { - "value": "AssociationStatus", - "name": "ASSOCIATION_STATUS" - } - ] + "type": "enum", + "members": { + "INSTANCE_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceIds" + } + }, + "AGENT_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AgentVersion" + } + }, + "PING_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PingStatus" + } + }, + "PLATFORM_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlatformTypes" + } + }, + "ACTIVATION_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivationIds" + } + }, + "IAM_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamRole" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "ASSOCIATION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationStatus" + } + } } }, "com.amazonaws.ssm#InstanceInformationFilterList": { @@ -12641,51 +13170,56 @@ "InstalledCount": { "target": "com.amazonaws.ssm#PatchInstalledCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches from the patch baseline that are installed on the managed node.
" } }, "InstalledOtherCount": { "target": "com.amazonaws.ssm#PatchInstalledOtherCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches not specified in the patch baseline that are installed on the managed\n node.
" } }, "InstalledPendingRebootCount": { "target": "com.amazonaws.ssm#PatchInstalledPendingRebootCount", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of patches installed by Patch Manager since the last time the managed node was\n rebooted.
" } }, "InstalledRejectedCount": { "target": "com.amazonaws.ssm#PatchInstalledRejectedCount", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of patches installed on a managed node that are specified in a\n RejectedPatches list. Patches with a status of InstalledRejected were\n typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of InstalledRejectedCount will\n always be 0 (zero).
The number of patches from the patch baseline that are applicable for the managed node but\n aren't currently installed.
" } }, "FailedCount": { "target": "com.amazonaws.ssm#PatchFailedCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches from the patch baseline that were attempted to be installed during the\n last patching operation, but failed to install.
" } }, "UnreportedNotApplicableCount": { "target": "com.amazonaws.ssm#PatchUnreportedNotApplicableCount", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of patches beyond the supported limit of NotApplicableCount that\n aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
The number of patches from the patch baseline that aren't applicable for the managed node\n and therefore aren't installed on the node. This number may be truncated if the list of patch\n names is very large. The number of patches beyond this limit are reported in\n UnreportedNotApplicableCount.
The number of managed nodes where patches that are specified as Critical for\n compliance reporting in the patch baseline aren't installed. These patches might be missing, have\n failed installation, were rejected, or were installed but awaiting a required managed node\n reboot. The status of these managed nodes is NON_COMPLIANT.
The number of managed nodes where patches that are specified as Security in a\n patch advisory aren't installed. These patches might be missing, have failed installation, were\n rejected, or were installed but awaiting a required managed node reboot. The status of these\n managed nodes is NON_COMPLIANT.
The number of managed nodes with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these managed nodes is NON_COMPLIANT.
The specified tag key or value is not valid.
", + "smithy.api#documentation": "The tag key or value isn't valid.
", "smithy.api#error": "client" } }, @@ -13707,18 +14253,20 @@ } }, "com.amazonaws.ssm#InventoryAttributeDataType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "string", - "name": "STRING" - }, - { - "value": "number", - "name": "NUMBER" + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" } - ] + } } }, "com.amazonaws.ssm#InventoryDeletionLastStatusMessage": { @@ -13731,18 +14279,20 @@ "type": "timestamp" }, "com.amazonaws.ssm#InventoryDeletionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Complete", - "name": "COMPLETE" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + } } }, "com.amazonaws.ssm#InventoryDeletionStatusItem": { @@ -13801,12 +14351,14 @@ "TotalCount": { "target": "com.amazonaws.ssm#TotalCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of items to delete. This count doesn't change during the delete\n operation.
" } }, "RemainingCount": { "target": "com.amazonaws.ssm#RemainingCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Remaining number of items to delete.
" } }, @@ -13833,12 +14385,14 @@ "Count": { "target": "com.amazonaws.ssm#ResourceCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A count of the number of deleted items.
" } }, "RemainingCount": { "target": "com.amazonaws.ssm#RemainingCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The remaining number of items to delete.
" } } @@ -14200,34 +14754,44 @@ } }, "com.amazonaws.ssm#InventoryQueryOperatorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Equal", - "name": "EQUAL" - }, - { - "value": "NotEqual", - "name": "NOT_EQUAL" - }, - { - "value": "BeginWith", - "name": "BEGIN_WITH" - }, - { - "value": "LessThan", - "name": "LESS_THAN" - }, - { - "value": "GreaterThan", - "name": "GREATER_THAN" - }, - { - "value": "Exists", - "name": "EXISTS" - } - ] + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEqual" + } + }, + "BEGIN_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BeginWith" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exists" + } + } } }, "com.amazonaws.ssm#InventoryResultEntity": { @@ -14316,18 +14880,20 @@ } }, "com.amazonaws.ssm#InventorySchemaDeleteOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DisableSchema", - "name": "DISABLE_SCHEMA" - }, - { - "value": "DeleteSchema", - "name": "DELETE_SCHEMA" + "type": "enum", + "members": { + "DISABLE_SCHEMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisableSchema" } - ] + }, + "DELETE_SCHEMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteSchema" + } + } } }, "com.amazonaws.ssm#InventoryTypeDisplayName": { @@ -14355,7 +14921,10 @@ } }, "com.amazonaws.ssm#IsSubTypeSchema": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#ItemContentMismatchException": { "type": "structure", @@ -14443,7 +15012,7 @@ "ParameterVersion": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The specific version of the parameter on which you want to attach one or more labels. If no\n version is specified, the system attaches the label to the latest version.
" } }, @@ -14468,6 +15037,7 @@ "ParameterVersion": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of the parameter that has been labeled.
" } } @@ -14477,22 +15047,26 @@ "type": "string" }, "com.amazonaws.ssm#LastResourceDataSyncStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Successful", - "name": "SUCCESSFUL" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "InProgress", - "name": "INPROGRESS" + "type": "enum", + "members": { + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } } }, "com.amazonaws.ssm#LastResourceDataSyncTime": { @@ -14543,7 +15117,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -14610,7 +15184,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -14692,7 +15266,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#CommandMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "(Optional) The maximum number of items to return for this call. The call also returns a\n token that you can specify in a subsequent call to get the next set of results.
" } }, @@ -14711,6 +15285,7 @@ "Details": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "(Optional) If set this returns the response of the command executions and any command\n output. The default value is false.
(Optional) The maximum number of items to return for this call. The call also returns a\n token that you can specify in a subsequent call to get the next set of results.
" } }, @@ -14886,7 +15461,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -14956,7 +15531,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. Currently, you can specify null or 50.\n The call also returns a token that you can specify in a subsequent call to get the next set of\n results.
" } } @@ -15037,7 +15612,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -15120,7 +15695,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -15196,7 +15771,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -15286,7 +15861,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -15506,6 +16081,7 @@ "com.amazonaws.ssm#ListOpsMetadataMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -15524,7 +16100,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#ListOpsMetadataMaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } }, @@ -15600,7 +16176,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -15670,7 +16246,7 @@ "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" } } @@ -15775,10 +16351,16 @@ } }, "com.amazonaws.ssm#Long": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#MaintenanceWindowAutomationParameters": { "type": "structure", @@ -15803,6 +16385,7 @@ "com.amazonaws.ssm#MaintenanceWindowCutoff": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 23 @@ -15822,6 +16405,7 @@ "com.amazonaws.ssm#MaintenanceWindowDurationHours": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 24 @@ -15829,7 +16413,10 @@ } }, "com.amazonaws.ssm#MaintenanceWindowEnabled": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#MaintenanceWindowExecution": { "type": "structure", @@ -15892,42 +16479,56 @@ } }, "com.amazonaws.ssm#MaintenanceWindowExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "Pending" - }, - { - "value": "IN_PROGRESS", - "name": "InProgress" - }, - { - "value": "SUCCESS", - "name": "Success" - }, - { - "value": "FAILED", - "name": "Failed" - }, - { - "value": "TIMED_OUT", - "name": "TimedOut" - }, - { - "value": "CANCELLING", - "name": "Cancelling" - }, - { - "value": "CANCELLED", - "name": "Cancelled" - }, - { - "value": "SKIPPED_OVERLAPPING", - "name": "SkippedOverlapping" - } - ] + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + }, + "Cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "SkippedOverlapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED_OVERLAPPING" + } + } } }, "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails": { @@ -16008,6 +16609,18 @@ "traits": { "smithy.api#documentation": "The type of task that ran.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm applied to your maintenance window task.
" + } + }, + "TriggeredAlarms": { + "target": "com.amazonaws.ssm#AlarmStateInformationList", + "traits": { + "smithy.api#documentation": "The CloudWatch alarm that was invoked by the maintenance window task.
" + } } }, "traits": { @@ -16212,18 +16825,21 @@ "Enabled": { "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the maintenance window is enabled.
" } }, "Duration": { "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration of the maintenance window in hours.
" } }, "Cutoff": { "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling\n new tasks for execution.
" } }, @@ -16242,7 +16858,7 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of days to wait to run a maintenance window after the scheduled cron expression\n date and time.
" } }, @@ -16352,6 +16968,7 @@ "com.amazonaws.ssm#MaintenanceWindowMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 10, "max": 100 @@ -16371,6 +16988,7 @@ "com.amazonaws.ssm#MaintenanceWindowOffset": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 6 @@ -16378,18 +16996,20 @@ } }, "com.amazonaws.ssm#MaintenanceWindowResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INSTANCE", - "name": "Instance" - }, - { - "value": "RESOURCE_GROUP", - "name": "ResourceGroup" + "type": "enum", + "members": { + "Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" + } + }, + "ResourceGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_GROUP" } - ] + } } }, "com.amazonaws.ssm#MaintenanceWindowRunCommandParameters": { @@ -16455,7 +17075,7 @@ "TimeoutSeconds": { "target": "com.amazonaws.ssm#TimeoutSeconds", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "If this time is reached and the command hasn't already started running, it doesn't\n run.
" } } @@ -16476,6 +17096,7 @@ "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -16631,6 +17252,7 @@ "Priority": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The priority of the task in the maintenance window. The lower the number, the higher the\n priority. Tasks that have the same priority are scheduled in parallel.
" } }, @@ -16675,6 +17297,12 @@ "traits": { "smithy.api#documentation": "The specification for whether tasks should continue to run after the cutoff time specified\n in the maintenance windows is reached.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm applied to your maintenance window task.
" + } } }, "traits": { @@ -16691,18 +17319,20 @@ } }, "com.amazonaws.ssm#MaintenanceWindowTaskCutoffBehavior": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONTINUE_TASK", - "name": "ContinueTask" - }, - { - "value": "CANCEL_TASK", - "name": "CancelTask" + "type": "enum", + "members": { + "ContinueTask": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUE_TASK" } - ] + }, + "CancelTask": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_TASK" + } + } } }, "com.amazonaws.ssm#MaintenanceWindowTaskId": { @@ -16820,6 +17450,7 @@ "com.amazonaws.ssm#MaintenanceWindowTaskPriority": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -16835,26 +17466,32 @@ } }, "com.amazonaws.ssm#MaintenanceWindowTaskType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUN_COMMAND", - "name": "RunCommand" - }, - { - "value": "AUTOMATION", - "name": "Automation" - }, - { - "value": "STEP_FUNCTIONS", - "name": "StepFunctions" - }, - { - "value": "LAMBDA", - "name": "Lambda" - } - ] + "type": "enum", + "members": { + "RunCommand": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUN_COMMAND" + } + }, + "Automation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATION" + } + }, + "StepFunctions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STEP_FUNCTIONS" + } + }, + "Lambda": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + } } }, "com.amazonaws.ssm#MaintenanceWindowTimezone": { @@ -16915,6 +17552,7 @@ "com.amazonaws.ssm#MaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -16924,6 +17562,7 @@ "com.amazonaws.ssm#MaxResultsEC2Compatible": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 5, "max": 50 @@ -17079,6 +17718,7 @@ "NonCompliantCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of compliance items that aren't compliant.
" } }, @@ -17132,34 +17772,44 @@ } }, "com.amazonaws.ssm#NotificationEvent": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "All", - "name": "ALL" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Success", - "name": "SUCCESS" - }, - { - "value": "TimedOut", - "name": "TIMED_OUT" - }, - { - "value": "Cancelled", - "name": "CANCELLED" - }, - { - "value": "Failed", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimedOut" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.ssm#NotificationEventList": { @@ -17169,73 +17819,97 @@ } }, "com.amazonaws.ssm#NotificationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Command", - "name": "Command" - }, - { - "value": "Invocation", - "name": "Invocation" + "type": "enum", + "members": { + "Command": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Command" } - ] + }, + "Invocation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Invocation" + } + } } }, "com.amazonaws.ssm#OperatingSystem": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "Windows" - }, - { - "value": "AMAZON_LINUX", - "name": "AmazonLinux" - }, - { - "value": "AMAZON_LINUX_2", - "name": "AmazonLinux2" - }, - { - "value": "UBUNTU", - "name": "Ubuntu" - }, - { - "value": "REDHAT_ENTERPRISE_LINUX", - "name": "RedhatEnterpriseLinux" - }, - { - "value": "SUSE", - "name": "Suse" - }, - { - "value": "CENTOS", - "name": "CentOS" - }, - { - "value": "ORACLE_LINUX", - "name": "OracleLinux" - }, - { - "value": "DEBIAN", - "name": "Debian" - }, - { - "value": "MACOS", - "name": "MacOS" - }, - { - "value": "RASPBIAN", - "name": "Raspbian" - }, - { - "value": "ROCKY_LINUX", - "name": "Rocky_Linux" - } - ] + "type": "enum", + "members": { + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + }, + "AmazonLinux": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX" + } + }, + "AmazonLinux2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX_2" + } + }, + "Ubuntu": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU" + } + }, + "RedhatEnterpriseLinux": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDHAT_ENTERPRISE_LINUX" + } + }, + "Suse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSE" + } + }, + "CentOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CENTOS" + } + }, + "OracleLinux": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE_LINUX" + } + }, + "Debian": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBIAN" + } + }, + "MacOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MACOS" + } + }, + "Raspbian": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RASPBIAN" + } + }, + "Rocky_Linux": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROCKY_LINUX" + } + } } }, "com.amazonaws.ssm#OpsAggregator": { @@ -17509,34 +18183,44 @@ } }, "com.amazonaws.ssm#OpsFilterOperatorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Equal", - "name": "EQUAL" - }, - { - "value": "NotEqual", - "name": "NOT_EQUAL" - }, - { - "value": "BeginWith", - "name": "BEGIN_WITH" - }, - { - "value": "LessThan", - "name": "LESS_THAN" - }, - { - "value": "GreaterThan", - "name": "GREATER_THAN" - }, - { - "value": "Exists", - "name": "EXISTS" - } - ] + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEqual" + } + }, + "BEGIN_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BeginWith" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exists" + } + } } }, "com.amazonaws.ssm#OpsFilterValue": { @@ -17737,18 +18421,20 @@ } }, "com.amazonaws.ssm#OpsItemDataType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SearchableString", - "name": "SEARCHABLE_STRING" - }, - { - "value": "String", - "name": "STRING" + "type": "enum", + "members": { + "SEARCHABLE_STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SearchableString" } - ] + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + } } }, "com.amazonaws.ssm#OpsItemDataValue": { @@ -17817,25 +18503,25 @@ } }, "com.amazonaws.ssm#OpsItemEventFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OpsItemId", - "name": "OPSITEM_ID" + "type": "enum", + "members": { + "OPSITEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpsItemId" } - ] + } } }, "com.amazonaws.ssm#OpsItemEventFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Equal", - "name": "EQUAL" + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" } - ] + } } }, "com.amazonaws.ssm#OpsItemEventFilterValue": { @@ -17863,7 +18549,6 @@ "com.amazonaws.ssm#OpsItemEventMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 @@ -17956,141 +18641,199 @@ } }, "com.amazonaws.ssm#OpsItemFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Status", - "name": "STATUS" - }, - { - "value": "CreatedBy", - "name": "CREATED_BY" - }, - { - "value": "Source", - "name": "SOURCE" - }, - { - "value": "Priority", - "name": "PRIORITY" - }, - { - "value": "Title", - "name": "TITLE" - }, - { - "value": "OpsItemId", - "name": "OPSITEM_ID" - }, - { - "value": "CreatedTime", - "name": "CREATED_TIME" - }, - { - "value": "LastModifiedTime", - "name": "LAST_MODIFIED_TIME" - }, - { - "value": "ActualStartTime", - "name": "ACTUAL_START_TIME" - }, - { - "value": "ActualEndTime", - "name": "ACTUAL_END_TIME" - }, - { - "value": "PlannedStartTime", - "name": "PLANNED_START_TIME" - }, - { - "value": "PlannedEndTime", - "name": "PLANNED_END_TIME" - }, - { - "value": "OperationalData", - "name": "OPERATIONAL_DATA" - }, - { - "value": "OperationalDataKey", - "name": "OPERATIONAL_DATA_KEY" - }, - { - "value": "OperationalDataValue", - "name": "OPERATIONAL_DATA_VALUE" - }, - { - "value": "ResourceId", - "name": "RESOURCE_ID" - }, - { - "value": "AutomationId", - "name": "AUTOMATION_ID" - }, - { - "value": "Category", - "name": "CATEGORY" - }, - { - "value": "Severity", - "name": "SEVERITY" - }, - { - "value": "OpsItemType", - "name": "OPSITEM_TYPE" - }, - { - "value": "ChangeRequestByRequesterArn", - "name": "CHANGE_REQUEST_REQUESTER_ARN" - }, - { - "value": "ChangeRequestByRequesterName", - "name": "CHANGE_REQUEST_REQUESTER_NAME" - }, - { - "value": "ChangeRequestByApproverArn", - "name": "CHANGE_REQUEST_APPROVER_ARN" - }, - { - "value": "ChangeRequestByApproverName", - "name": "CHANGE_REQUEST_APPROVER_NAME" - }, - { - "value": "ChangeRequestByTemplate", - "name": "CHANGE_REQUEST_TEMPLATE" - }, - { - "value": "ChangeRequestByTargetsResourceGroup", - "name": "CHANGE_REQUEST_TARGETS_RESOURCE_GROUP" - }, - { - "value": "InsightByType", - "name": "INSIGHT_TYPE" - } - ] + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CREATED_BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedBy" + } + }, + "SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Source" + } + }, + "PRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Priority" + } + }, + "TITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Title" + } + }, + "OPSITEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpsItemId" + } + }, + "CREATED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedTime" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + }, + "ACTUAL_START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActualStartTime" + } + }, + "ACTUAL_END_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActualEndTime" + } + }, + "PLANNED_START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlannedStartTime" + } + }, + "PLANNED_END_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlannedEndTime" + } + }, + "OPERATIONAL_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OperationalData" + } + }, + "OPERATIONAL_DATA_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OperationalDataKey" + } + }, + "OPERATIONAL_DATA_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OperationalDataValue" + } + }, + "RESOURCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceId" + } + }, + "AUTOMATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutomationId" + } + }, + "CATEGORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Category" + } + }, + "SEVERITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Severity" + } + }, + "OPSITEM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpsItemType" + } + }, + "CHANGE_REQUEST_REQUESTER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequestByRequesterArn" + } + }, + "CHANGE_REQUEST_REQUESTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequestByRequesterName" + } + }, + "CHANGE_REQUEST_APPROVER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequestByApproverArn" + } + }, + "CHANGE_REQUEST_APPROVER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequestByApproverName" + } + }, + "CHANGE_REQUEST_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequestByTemplate" + } + }, + "CHANGE_REQUEST_TARGETS_RESOURCE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeRequestByTargetsResourceGroup" + } + }, + "INSIGHT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsightByType" + } + } } }, "com.amazonaws.ssm#OpsItemFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Equal", - "name": "EQUAL" - }, - { - "value": "Contains", - "name": "CONTAINS" - }, - { - "value": "GreaterThan", - "name": "GREATER_THAN" - }, - { - "value": "LessThan", - "name": "LESS_THAN" - } - ] + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Contains" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + } } }, "com.amazonaws.ssm#OpsItemFilterValue": { @@ -18154,7 +18897,10 @@ "target": "com.amazonaws.ssm#OpsItemParameterNamesList" }, "Limit": { - "target": "com.amazonaws.ssm#Integer" + "target": "com.amazonaws.ssm#Integer", + "traits": { + "smithy.api#default": 0 + } }, "LimitType": { "target": "com.amazonaws.ssm#String" @@ -18175,7 +18921,6 @@ "com.amazonaws.ssm#OpsItemMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 @@ -18242,7 +18987,6 @@ "com.amazonaws.ssm#OpsItemPriority": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 5 @@ -18391,33 +19135,37 @@ } }, "com.amazonaws.ssm#OpsItemRelatedItemsFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ResourceType", - "name": "RESOURCE_TYPE" - }, - { - "value": "AssociationId", - "name": "ASSOCIATION_ID" - }, - { - "value": "ResourceUri", - "name": "RESOURCE_URI" + "type": "enum", + "members": { + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "ASSOCIATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationId" + } + }, + "RESOURCE_URI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceUri" } - ] + } } }, "com.amazonaws.ssm#OpsItemRelatedItemsFilterOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Equal", - "name": "EQUAL" + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" } - ] + } } }, "com.amazonaws.ssm#OpsItemRelatedItemsFilterValue": { @@ -18438,7 +19186,6 @@ "com.amazonaws.ssm#OpsItemRelatedItemsMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 @@ -18452,100 +19199,136 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^(?!\\s*$).+$" - } - }, - "com.amazonaws.ssm#OpsItemSource": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.ssm#OpsItemSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.ssm#OpsItemStatus": { + "type": "enum", + "members": { + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Open" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Resolved" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimedOut" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelling" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "COMPLETED_WITH_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithSuccess" + } + }, + "COMPLETED_WITH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithFailure" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "RUNBOOK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RunbookInProgress" + } + }, + "PENDING_CHANGE_CALENDAR_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingChangeCalendarOverride" + } + }, + "CHANGE_CALENDAR_OVERRIDE_APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeCalendarOverrideApproved" + } + }, + "CHANGE_CALENDAR_OVERRIDE_REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeCalendarOverrideRejected" + } + }, + "PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingApproval" + } }, - "smithy.api#pattern": "^(?!\\s*$).+$" - } - }, - "com.amazonaws.ssm#OpsItemStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Open", - "name": "OPEN" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Resolved", - "name": "RESOLVED" - }, - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "TimedOut", - "name": "TIMED_OUT" - }, - { - "value": "Cancelling", - "name": "CANCELLING" - }, - { - "value": "Cancelled", - "name": "CANCELLED" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "CompletedWithSuccess", - "name": "COMPLETED_WITH_SUCCESS" - }, - { - "value": "CompletedWithFailure", - "name": "COMPLETED_WITH_FAILURE" - }, - { - "value": "Scheduled", - "name": "SCHEDULED" - }, - { - "value": "RunbookInProgress", - "name": "RUNBOOK_IN_PROGRESS" - }, - { - "value": "PendingChangeCalendarOverride", - "name": "PENDING_CHANGE_CALENDAR_OVERRIDE" - }, - { - "value": "ChangeCalendarOverrideApproved", - "name": "CHANGE_CALENDAR_OVERRIDE_APPROVED" - }, - { - "value": "ChangeCalendarOverrideRejected", - "name": "CHANGE_CALENDAR_OVERRIDE_REJECTED" - }, - { - "value": "PendingApproval", - "name": "PENDING_APPROVAL" - }, - { - "value": "Approved", - "name": "APPROVED" - }, - { - "value": "Rejected", - "name": "REJECTED" - }, - { - "value": "Closed", - "name": "CLOSED" - } - ] + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Closed" + } + } } }, "com.amazonaws.ssm#OpsItemSummaries": { @@ -19004,7 +19787,10 @@ } }, "com.amazonaws.ssm#PSParameterVersion": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#Parameter": { "type": "structure", @@ -19030,6 +19816,7 @@ "Version": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The parameter version.
" } }, @@ -19156,6 +19943,7 @@ "Version": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The parameter version.
" } }, @@ -19337,6 +20125,7 @@ "Version": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The parameter version.
" } }, @@ -19508,41 +20297,49 @@ } }, "com.amazonaws.ssm#ParameterTier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Standard", - "name": "STANDARD" - }, - { - "value": "Advanced", - "name": "ADVANCED" - }, - { - "value": "Intelligent-Tiering", - "name": "INTELLIGENT_TIERING" + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "ADVANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Advanced" } - ] + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Intelligent-Tiering" + } + } } }, "com.amazonaws.ssm#ParameterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "String", - "name": "STRING" - }, - { - "value": "StringList", - "name": "STRING_LIST" - }, - { - "value": "SecureString", - "name": "SECURE_STRING" + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "STRING_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringList" + } + }, + "SECURE_STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecureString" } - ] + } } }, "com.amazonaws.ssm#ParameterValue": { @@ -19621,22 +20418,26 @@ } }, "com.amazonaws.ssm#ParametersFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Name", - "name": "NAME" - }, - { - "value": "Type", - "name": "TYPE" - }, - { - "value": "KeyId", - "name": "KEY_ID" + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Type" + } + }, + "KEY_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KeyId" } - ] + } } }, "com.amazonaws.ssm#ParametersFilterList": { @@ -19774,6 +20575,7 @@ "Epoch": { "target": "com.amazonaws.ssm#PatchEpoch", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The epoch of the patch. For example in\n pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is\n 20180914-2. Applies to Linux-based managed nodes only.
Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch\n baselines. For example, you can create a default patch baseline for each operating system.
" } } @@ -19886,6 +20691,7 @@ "com.amazonaws.ssm#PatchBaselineMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -19979,74 +20785,97 @@ } }, "com.amazonaws.ssm#PatchComplianceDataState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INSTALLED", - "name": "Installed" - }, - { - "value": "INSTALLED_OTHER", - "name": "InstalledOther" - }, - { - "value": "INSTALLED_PENDING_REBOOT", - "name": "InstalledPendingReboot" - }, - { - "value": "INSTALLED_REJECTED", - "name": "InstalledRejected" - }, - { - "value": "MISSING", - "name": "Missing" - }, - { - "value": "NOT_APPLICABLE", - "name": "NotApplicable" - }, - { - "value": "FAILED", - "name": "Failed" - } - ] + "type": "enum", + "members": { + "Installed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTALLED" + } + }, + "InstalledOther": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTALLED_OTHER" + } + }, + "InstalledPendingReboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTALLED_PENDING_REBOOT" + } + }, + "InstalledRejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTALLED_REJECTED" + } + }, + "Missing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING" + } + }, + "NotApplicable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.ssm#PatchComplianceLevel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "Critical" - }, - { - "value": "HIGH", - "name": "High" - }, - { - "value": "MEDIUM", - "name": "Medium" - }, - { - "value": "LOW", - "name": "Low" - }, - { - "value": "INFORMATIONAL", - "name": "Informational" - }, - { - "value": "UNSPECIFIED", - "name": "Unspecified" - } - ] + "type": "enum", + "members": { + "Critical": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + }, + "High": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "Medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "Low": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "Informational": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFORMATIONAL" + } + }, + "Unspecified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + } } }, "com.amazonaws.ssm#PatchComplianceMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 10, "max": 100 @@ -20057,39 +20886,54 @@ "type": "string" }, "com.amazonaws.ssm#PatchCriticalNonCompliantCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchDeploymentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPROVED", - "name": "Approved" - }, - { - "value": "PENDING_APPROVAL", - "name": "PendingApproval" - }, - { - "value": "EXPLICIT_APPROVED", - "name": "ExplicitApproved" - }, - { - "value": "EXPLICIT_REJECTED", - "name": "ExplicitRejected" - } - ] + "type": "enum", + "members": { + "Approved": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "PendingApproval": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_APPROVAL" + } + }, + "ExplicitApproved": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLICIT_APPROVED" + } + }, + "ExplicitRejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLICIT_REJECTED" + } + } } }, "com.amazonaws.ssm#PatchDescription": { "type": "string" }, "com.amazonaws.ssm#PatchEpoch": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchFailedCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchFilter": { "type": "structure", @@ -20129,86 +20973,122 @@ } }, "com.amazonaws.ssm#PatchFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARCH", - "name": "Arch" - }, - { - "value": "ADVISORY_ID", - "name": "AdvisoryId" - }, - { - "value": "BUGZILLA_ID", - "name": "BugzillaId" - }, - { - "value": "PATCH_SET", - "name": "PatchSet" - }, - { - "value": "PRODUCT", - "name": "Product" - }, - { - "value": "PRODUCT_FAMILY", - "name": "ProductFamily" - }, - { - "value": "CLASSIFICATION", - "name": "Classification" - }, - { - "value": "CVE_ID", - "name": "CVEId" - }, - { - "value": "EPOCH", - "name": "Epoch" - }, - { - "value": "MSRC_SEVERITY", - "name": "MsrcSeverity" - }, - { - "value": "NAME", - "name": "Name" - }, - { - "value": "PATCH_ID", - "name": "PatchId" - }, - { - "value": "SECTION", - "name": "Section" - }, - { - "value": "PRIORITY", - "name": "Priority" - }, - { - "value": "REPOSITORY", - "name": "Repository" - }, - { - "value": "RELEASE", - "name": "Release" - }, - { - "value": "SEVERITY", - "name": "Severity" - }, - { - "value": "SECURITY", - "name": "Security" - }, - { - "value": "VERSION", - "name": "Version" - } - ] + "type": "enum", + "members": { + "Arch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCH" + } + }, + "AdvisoryId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADVISORY_ID" + } + }, + "BugzillaId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUGZILLA_ID" + } + }, + "PatchSet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATCH_SET" + } + }, + "Product": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCT" + } + }, + "ProductFamily": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCT_FAMILY" + } + }, + "Classification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIFICATION" + } + }, + "CVEId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CVE_ID" + } + }, + "Epoch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EPOCH" + } + }, + "MsrcSeverity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSRC_SEVERITY" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PatchId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATCH_ID" + } + }, + "Section": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECTION" + } + }, + "Priority": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITY" + } + }, + "Repository": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPOSITORY" + } + }, + "Release": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEASE" + } + }, + "Severity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVERITY" + } + }, + "Security": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY" + } + }, + "Version": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION" + } + } } }, "com.amazonaws.ssm#PatchFilterList": { @@ -20308,16 +21188,28 @@ } }, "com.amazonaws.ssm#PatchInstalledCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchInstalledOtherCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchInstalledPendingRebootCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchInstalledRejectedCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchKbNumber": { "type": "string" @@ -20332,7 +21224,10 @@ } }, "com.amazonaws.ssm#PatchMissingCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchMsrcNumber": { "type": "string" @@ -20344,21 +21239,26 @@ "type": "string" }, "com.amazonaws.ssm#PatchNotApplicableCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchOperationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Scan", - "name": "SCAN" - }, - { - "value": "Install", - "name": "INSTALL" + "type": "enum", + "members": { + "SCAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scan" + } + }, + "INSTALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Install" } - ] + } } }, "com.amazonaws.ssm#PatchOrchestratorFilter": { @@ -20418,7 +21318,10 @@ } }, "com.amazonaws.ssm#PatchOtherNonCompliantCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#PatchProduct": { "type": "string" @@ -20433,34 +21336,44 @@ } }, "com.amazonaws.ssm#PatchProperty": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRODUCT", - "name": "Product" - }, - { - "value": "PRODUCT_FAMILY", - "name": "PatchProductFamily" - }, - { - "value": "CLASSIFICATION", - "name": "PatchClassification" - }, - { - "value": "MSRC_SEVERITY", - "name": "PatchMsrcSeverity" - }, - { - "value": "PRIORITY", - "name": "PatchPriority" - }, - { - "value": "SEVERITY", - "name": "PatchSeverity" - } - ] + "type": "enum", + "members": { + "Product": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCT" + } + }, + "PatchProductFamily": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCT_FAMILY" + } + }, + "PatchClassification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIFICATION" + } + }, + "PatchMsrcSeverity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSRC_SEVERITY" + } + }, + "PatchPriority": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITY" + } + }, + "PatchSeverity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVERITY" + } + } } }, "com.amazonaws.ssm#PatchPropertyEntry": { @@ -20497,7 +21410,7 @@ "ApproveAfterDays": { "target": "com.amazonaws.ssm#ApproveAfterDays", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of days after the release date of each patch matched by the rule that the patch\n is marked as approved in the patch baseline. For example, a value of 7 means that\n patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu\n Server.
For managed nodes identified by the approval rule filters, enables a patch baseline to apply\n non-security updates available in the specified repository. The default value is\n false. Applies to Linux managed nodes only.
The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the\n current Automation execution.
" } }, "SuccessSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of steps that successfully completed in all specified Amazon Web Services Regions and\n Amazon Web Services accounts for the current Automation execution.
" } }, "FailedSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of steps that failed to run in all specified Amazon Web Services Regions and\n Amazon Web Services accounts for the current Automation execution.
" } }, "CancelledSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of steps that the system cancelled in all specified Amazon Web Services Regions and\n Amazon Web Services accounts for the current Automation execution.
" } }, "TimedOutSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts\n for the current Automation execution.
" } } @@ -21067,7 +22001,7 @@ "Overwrite": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Overwrite an existing parameter. The default value is false.
The new version number of a parameter. If you edit a parameter value, Parameter Store\n automatically creates a new version and assigns this new version a unique ID. You can reference a\n parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you\n don't specify a specific version, the system returns the latest parameter value when a parameter\n is called.
" } }, @@ -21121,18 +22056,20 @@ } }, "com.amazonaws.ssm#RebootOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RebootIfNeeded", - "name": "REBOOT_IF_NEEDED" - }, - { - "value": "NoReboot", - "name": "NO_REBOOT" + "type": "enum", + "members": { + "REBOOT_IF_NEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootIfNeeded" } - ] + }, + "NO_REBOOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoReboot" + } + } } }, "com.amazonaws.ssm#Region": { @@ -21429,7 +22366,7 @@ "Priority": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The priority of the task in the maintenance window, the lower the number the higher the\n priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the\n same priority scheduled in parallel.
" } }, @@ -21475,6 +22412,12 @@ "traits": { "smithy.api#documentation": "Indicates whether tasks should continue to run after the cutoff time specified in the\n maintenance windows is reached.
\n\n CONTINUE_TASK: When the cutoff time is reached, any tasks that are running\n continue. The default value.
\n CANCEL_TASK:
For Automation, Lambda, Step Functions tasks: When the cutoff\n time is reached, any task invocations that are already running continue, but no new task\n invocations are started.
\nFor Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the\n task. However, there is no guarantee that the command will be terminated and the underlying\n process stopped.
\nThe status for tasks that are not completed is TIMED_OUT.
The CloudWatch alarm you want to apply to your maintenance window task.
" + } } } }, @@ -21492,6 +22435,7 @@ "com.amazonaws.ssm#RegistrationLimit": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000 @@ -21549,6 +22493,7 @@ "com.amazonaws.ssm#RegistrationsCount": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000 @@ -21577,7 +22522,10 @@ } }, "com.amazonaws.ssm#RemainingCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#RemoveTagsFromResource": { "type": "operation", @@ -21699,6 +22647,7 @@ "Truncated": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A boolean value indicating whether the resolved target list is truncated.
" } } @@ -21773,7 +22722,10 @@ } }, "com.amazonaws.ssm#ResourceCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#ResourceCountByStatus": { "type": "string" @@ -21884,10 +22836,16 @@ } }, "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.ssm#ResourceDataSyncInvalidConfigurationException": { "type": "structure", @@ -22115,14 +23073,14 @@ } }, "com.amazonaws.ssm#ResourceDataSyncS3Format": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JsonSerDe", - "name": "JSON_SERDE" + "type": "enum", + "members": { + "JSON_SERDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JsonSerDe" } - ] + } } }, "com.amazonaws.ssm#ResourceDataSyncS3Prefix": { @@ -22169,12 +23127,14 @@ "IncludeFutureRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those\n Regions come online.
" } }, "EnableAllOpsDataSources": { "target": "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager\n automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in\n your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the\n Amazon Web Services Systems Manager User Guide.
" } } @@ -22231,6 +23191,7 @@ "IncludeFutureRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those\n Regions come online.
" } }, @@ -22243,6 +23204,7 @@ "EnableAllOpsDataSources": { "target": "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager\n automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in\n your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the\n Amazon Web Services Systems Manager User Guide.
" } } @@ -22305,69 +23267,92 @@ } }, "com.amazonaws.ssm#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ManagedInstance", - "name": "MANAGED_INSTANCE" - }, - { - "value": "Document", - "name": "DOCUMENT" - }, - { - "value": "EC2Instance", - "name": "EC2_INSTANCE" + "type": "enum", + "members": { + "MANAGED_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManagedInstance" + } + }, + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Document" + } + }, + "EC2_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2Instance" } - ] + } } }, "com.amazonaws.ssm#ResourceTypeForTagging": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Document", - "name": "DOCUMENT" - }, - { - "value": "ManagedInstance", - "name": "MANAGED_INSTANCE" - }, - { - "value": "MaintenanceWindow", - "name": "MAINTENANCE_WINDOW" - }, - { - "value": "Parameter", - "name": "PARAMETER" - }, - { - "value": "PatchBaseline", - "name": "PATCH_BASELINE" - }, - { - "value": "OpsItem", - "name": "OPS_ITEM" - }, - { - "value": "OpsMetadata", - "name": "OPSMETADATA" - }, - { - "value": "Automation", - "name": "AUTOMATION" - }, - { - "value": "Association", - "name": "ASSOCIATION" - } - ] + "type": "enum", + "members": { + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Document" + } + }, + "MANAGED_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManagedInstance" + } + }, + "MAINTENANCE_WINDOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceWindow" + } + }, + "PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Parameter" + } + }, + "PATCH_BASELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PatchBaseline" + } + }, + "OPS_ITEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpsItem" + } + }, + "OPSMETADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpsMetadata" + } + }, + "AUTOMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automation" + } + }, + "ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Association" + } + } } }, "com.amazonaws.ssm#ResponseCode": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#ResultAttribute": { "type": "structure", @@ -22495,26 +23480,32 @@ } }, "com.amazonaws.ssm#ReviewStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPROVED", - "name": "APPROVED" - }, - { - "value": "NOT_REVIEWED", - "name": "NOT_REVIEWED" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "REJECTED", - "name": "REJECTED" - } - ] + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "NOT_REVIEWED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_REVIEWED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + } } }, "com.amazonaws.ssm#Reviewer": { @@ -22681,6 +23672,7 @@ "com.amazonaws.ssm#ScheduleOffset": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 6 @@ -22864,7 +23856,7 @@ "TimeoutSeconds": { "target": "com.amazonaws.ssm#TimeoutSeconds", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "If this time is reached and the command hasn't already started running, it won't run.
" } }, @@ -22927,6 +23919,12 @@ "traits": { "smithy.api#documentation": "Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a\n capability of Amazon Web Services Systems Manager.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The CloudWatch alarm you want to apply to your command.
" + } } } }, @@ -23128,34 +24126,44 @@ } }, "com.amazonaws.ssm#SessionFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InvokedAfter", - "name": "INVOKED_AFTER" - }, - { - "value": "InvokedBefore", - "name": "INVOKED_BEFORE" - }, - { - "value": "Target", - "name": "TARGET_ID" - }, - { - "value": "Owner", - "name": "OWNER" - }, - { - "value": "Status", - "name": "STATUS" - }, - { - "value": "SessionId", - "name": "SESSION_ID" - } - ] + "type": "enum", + "members": { + "INVOKED_AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvokedAfter" + } + }, + "INVOKED_BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvokedBefore" + } + }, + "TARGET_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Target" + } + }, + "OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Owner" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "SESSION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionId" + } + } } }, "com.amazonaws.ssm#SessionFilterList": { @@ -23268,6 +24276,7 @@ "com.amazonaws.ssm#SessionMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 200 @@ -23294,49 +24303,61 @@ } }, "com.amazonaws.ssm#SessionState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "History", - "name": "HISTORY" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "HISTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "History" } - ] + } } }, "com.amazonaws.ssm#SessionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Connected", - "name": "CONNECTED" - }, - { - "value": "Connecting", - "name": "CONNECTING" - }, - { - "value": "Disconnected", - "name": "DISCONNECTED" - }, - { - "value": "Terminated", - "name": "TERMINATED" - }, - { - "value": "Terminating", - "name": "TERMINATING" - }, - { - "value": "Failed", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Connected" + } + }, + "CONNECTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Connecting" + } + }, + "DISCONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disconnected" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminated" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } } }, "com.amazonaws.ssm#SessionTarget": { @@ -23354,36 +24375,42 @@ "CriticalCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of resources or compliance items that have a severity level of\n Critical. Critical severity is determined by the organization that published the\n compliance items.
The total number of resources or compliance items that have a severity level of high. High\n severity is determined by the organization that published the compliance items.
" } }, "MediumCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of resources or compliance items that have a severity level of medium.\n Medium severity is determined by the organization that published the compliance items.
" } }, "LowCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of resources or compliance items that have a severity level of low. Low\n severity is determined by the organization that published the compliance items.
" } }, "InformationalCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of resources or compliance items that have a severity level of\n informational. Informational severity is determined by the organization that published the\n compliance items.
" } }, "UnspecifiedCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of resources or compliance items that have a severity level of unspecified.\n Unspecified severity is determined by the organization that published the compliance\n items.
" } } @@ -23404,30 +24431,38 @@ } }, "com.amazonaws.ssm#SignalType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Approve", - "name": "APPROVE" - }, - { - "value": "Reject", - "name": "REJECT" - }, - { - "value": "StartStep", - "name": "START_STEP" - }, - { - "value": "StopStep", - "name": "STOP_STEP" - }, - { - "value": "Resume", - "name": "RESUME" - } - ] + "type": "enum", + "members": { + "APPROVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approve" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Reject" + } + }, + "START_STEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartStep" + } + }, + "STOP_STEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopStep" + } + }, + "RESUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Resume" + } + } } }, "com.amazonaws.ssm#SnapshotDownloadUrl": { @@ -23454,22 +24489,26 @@ } }, "com.amazonaws.ssm#SourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS::EC2::Instance", - "name": "AWS_EC2_INSTANCE" - }, - { - "value": "AWS::IoT::Thing", - "name": "AWS_IOT_THING" - }, - { - "value": "AWS::SSM::ManagedInstance", - "name": "AWS_SSM_MANAGEDINSTANCE" + "type": "enum", + "members": { + "AWS_EC2_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::EC2::Instance" + } + }, + "AWS_IOT_THING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IoT::Thing" + } + }, + "AWS_SSM_MANAGEDINSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SSM::ManagedInstance" } - ] + } } }, "com.amazonaws.ssm#StandardErrorContent": { @@ -23636,6 +24675,12 @@ "traits": { "smithy.api#documentation": "Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key-value\n pairs:
\n\n Key=environment,Value=test\n
\n Key=OS,Value=Windows\n
To add tags to an existing automation, use the AddTagsToResource\n operation.
\nThe CloudWatch alarm you want to apply to your automation.
" + } } } }, @@ -23728,6 +24773,7 @@ "AutoApprove": { "target": "com.amazonaws.ssm#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the change request can be approved automatically without the need for\n manual approvals.
\nIf AutoApprovable is enabled in a change template, then setting\n AutoApprove to true in StartChangeRequestExecution\n creates a change request that bypasses approver review.
Change Calendar restrictions are not bypassed in this scenario. If the state of an\n associated calendar is CLOSED, change freeze approvers must still grant permission\n for this change request to run. If they don't, the change won't be processed until the calendar\n state is again OPEN.
The timeout seconds of the step.
" } }, @@ -23918,7 +24964,7 @@ "MaxAttempts": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The maximum number of tries to run the action of the step. The default value is\n 1.
The flag which can be used to end automation no matter whether the step succeeds or\n fails.
" } }, @@ -24004,7 +25050,7 @@ "IsCritical": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The flag which can be used to help decide whether the failure of current step leads to the\n Automation failure.
" } }, @@ -24054,34 +25100,44 @@ } }, "com.amazonaws.ssm#StepExecutionFilterKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "StartTimeBefore", - "name": "START_TIME_BEFORE" - }, - { - "value": "StartTimeAfter", - "name": "START_TIME_AFTER" - }, - { - "value": "StepExecutionStatus", - "name": "STEP_EXECUTION_STATUS" - }, - { - "value": "StepExecutionId", - "name": "STEP_EXECUTION_ID" - }, - { - "value": "StepName", - "name": "STEP_NAME" - }, - { - "value": "Action", - "name": "ACTION" - } - ] + "type": "enum", + "members": { + "START_TIME_BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTimeBefore" + } + }, + "START_TIME_AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTimeAfter" + } + }, + "STEP_EXECUTION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepExecutionStatus" + } + }, + "STEP_EXECUTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepExecutionId" + } + }, + "STEP_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepName" + } + }, + "ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Action" + } + } } }, "com.amazonaws.ssm#StepExecutionFilterList": { @@ -24169,18 +25225,20 @@ "members": {} }, "com.amazonaws.ssm#StopType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Complete", - "name": "COMPLETE" - }, - { - "value": "Cancel", - "name": "CANCEL" + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + }, + "CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancel" } - ] + } } }, "com.amazonaws.ssm#StreamUrl": { @@ -24292,7 +25350,10 @@ } }, "com.amazonaws.ssm#TargetCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#TargetInUseException": { "type": "structure", @@ -24529,6 +25590,7 @@ "com.amazonaws.ssm#TimeoutSeconds": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 30, "max": 2592000 @@ -24573,7 +25635,10 @@ } }, "com.amazonaws.ssm#TotalCount": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.ssm#TotalSizeLimitExceededException": { "type": "structure", @@ -24636,7 +25701,7 @@ "ParameterVersion": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The specific version of the parameter which you want to delete one or more labels from. If\n it isn't present, the call will fail.
", "smithy.api#required": {} } @@ -24926,6 +25991,7 @@ "ApplyOnlyAtCronInterval": { "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "By default, when you update an association, the system runs it immediately after it is\n updated and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you update it. This parameter isn't supported for rate\n expressions.
\n\nIf you chose this option when you created an association and later you edit that association\n or you make changes to the SSM document on which that association is based (by using the\n Documents page in the console), State Manager applies the association at the next specified cron\n interval. For example, if you chose the Latest version of an SSM document when you\n created an association and you edit the association by choosing a different document version on\n the Documents page, State Manager applies the association at the next specified cron interval if\n you previously selected this option. If this option wasn't selected, State Manager immediately\n runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval\n parameter when you update the association from the command line. This parameter forces the\n association to run immediately after updating it and according to the interval specified.
Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration" } } }, @@ -25326,42 +26395,42 @@ "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of days to wait after the date and time specified by a cron expression before\n running the maintenance window.
\nFor example, the following cron expression schedules a maintenance window to run the third\n Tuesday of every month at 11:30 PM.
\n\n cron(30 23 ? * TUE#3 *)\n
If the schedule offset is 2, the maintenance window won't run until two days\n later.
The duration of the maintenance window in hours.
" } }, "Cutoff": { "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling\n new tasks for execution.
" } }, "AllowUnassociatedTargets": { "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.
" } }, "Enabled": { "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Whether the maintenance window is enabled.
" } }, "Replace": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional\n fields that aren't specified are set to null.
The number of days to wait to run a maintenance window after the scheduled cron expression\n date and time.
" } }, "Duration": { "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration of the maintenance window in hours.
" } }, "Cutoff": { "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling\n new tasks for execution.
" } }, "AllowUnassociatedTargets": { "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.
" } }, "Enabled": { "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the maintenance window is enabled.
" } } @@ -25509,7 +26582,7 @@ "Replace": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API\n request. Optional fields that aren't specified are set to null.
The new task priority to specify. The lower the number, the higher the priority. Tasks that\n have the same priority are scheduled in parallel.
" } }, @@ -25663,7 +26736,7 @@ "Replace": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request.\n Optional fields that aren't specified are set to null.
" } }, @@ -25672,6 +26745,12 @@ "traits": { "smithy.api#documentation": "Indicates whether tasks should continue to run after the cutoff time specified in the\n maintenance windows is reached.
\n\n CONTINUE_TASK: When the cutoff time is reached, any tasks that are running\n continue. The default value.
\n CANCEL_TASK:
For Automation, Lambda, Step Functions tasks: When the cutoff\n time is reached, any task invocations that are already running continue, but no new task\n invocations are started.
\nFor Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the\n task. However, there is no guarantee that the command will be terminated and the underlying\n process stopped.
\nThe status for tasks that are not completed is TIMED_OUT.
The CloudWatch alarm you want to apply to your maintenance window task.
" + } } } }, @@ -25723,6 +26802,7 @@ "Priority": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The updated priority value.
" } }, @@ -25761,6 +26841,12 @@ "traits": { "smithy.api#documentation": "The specification for whether tasks should continue to run after the cutoff time specified\n in the maintenance windows is reached.
" } + }, + "AlarmConfiguration": { + "target": "com.amazonaws.ssm#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "The details for the CloudWatch alarm you applied to your maintenance window task.
" + } } } }, @@ -26063,7 +27149,7 @@ "ApprovedPatchesEnableNonSecurity": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
If True, then all fields that are required by the CreatePatchBaseline\n operation are also required for this API request. Optional fields that aren't specified are set\n to null.
" } } @@ -26148,7 +27234,7 @@ "ApprovedPatchesEnableNonSecurity": { "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#box": {}, + "smithy.api#default": null, "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Provides translation between one source language and another of the same set of\n languages.
", - "smithy.api#title": "Amazon Translate" - }, "version": "2017-07-01", "operations": [ { @@ -75,6 +60,9 @@ { "target": "com.amazonaws.translate#ListParallelData" }, + { + "target": "com.amazonaws.translate#ListTagsForResource" + }, { "target": "com.amazonaws.translate#ListTerminologies" }, @@ -87,13 +75,34 @@ { "target": "com.amazonaws.translate#StopTextTranslationJob" }, + { + "target": "com.amazonaws.translate#TagResource" + }, { "target": "com.amazonaws.translate#TranslateText" }, + { + "target": "com.amazonaws.translate#UntagResource" + }, { "target": "com.amazonaws.translate#UpdateParallelData" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Translate", + "arnNamespace": "translate", + "cloudFormationName": "Translate", + "cloudTrailEventSource": "translate.amazonaws.com", + "endpointPrefix": "translate" + }, + "aws.auth#sigv4": { + "name": "translate" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Provides translation between one source language and another of the same set of\n languages.
", + "smithy.api#title": "Amazon Translate" + } }, "com.amazonaws.translate#AppliedTerminology": { "type": "structure", @@ -186,6 +195,9 @@ "target": "com.amazonaws.translate#CreateParallelDataResponse" }, "errors": [ + { + "target": "com.amazonaws.translate#ConcurrentModificationException" + }, { "target": "com.amazonaws.translate#ConflictException" }, @@ -203,6 +215,9 @@ }, { "target": "com.amazonaws.translate#TooManyRequestsException" + }, + { + "target": "com.amazonaws.translate#TooManyTagsException" } ], "traits": { @@ -242,6 +257,9 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.translate#TagList" } } }, @@ -431,65 +449,85 @@ } }, "com.amazonaws.translate#Directionality": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNI", - "name": "UNI" - }, - { - "value": "MULTI", - "name": "MULTI" + "type": "enum", + "members": { + "UNI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNI" } - ] + }, + "MULTI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI" + } + } } }, "com.amazonaws.translate#DisplayLanguageCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "de", - "name": "DE" - }, - { - "value": "en", - "name": "EN" - }, - { - "value": "es", - "name": "ES" - }, - { - "value": "fr", - "name": "FR" - }, - { - "value": "it", - "name": "IT" - }, - { - "value": "ja", - "name": "JA" - }, - { - "value": "ko", - "name": "KO" - }, - { - "value": "pt", - "name": "PT" - }, - { - "value": "zh", - "name": "ZH" - }, - { - "value": "zh-TW", - "name": "ZH_TW" - } - ] + "type": "enum", + "members": { + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "JA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja" + } + }, + "KO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" + } + }, + "ZH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "ZH_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + } } }, "com.amazonaws.translate#EncryptionKey": { @@ -525,29 +563,31 @@ } }, "com.amazonaws.translate#EncryptionKeyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "KMS", - "name": "KMS" + "type": "enum", + "members": { + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" } - ] + } } }, "com.amazonaws.translate#Formality": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FORMAL", - "name": "FORMAL" - }, - { - "value": "INFORMAL", - "name": "INFORMAL" + "type": "enum", + "members": { + "FORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORMAL" } - ] + }, + "INFORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFORMAL" + } + } } }, "com.amazonaws.translate#GetParallelData": { @@ -703,6 +743,9 @@ "target": "com.amazonaws.translate#ImportTerminologyResponse" }, "errors": [ + { + "target": "com.amazonaws.translate#ConcurrentModificationException" + }, { "target": "com.amazonaws.translate#InternalServerException" }, @@ -714,6 +757,9 @@ }, { "target": "com.amazonaws.translate#TooManyRequestsException" + }, + { + "target": "com.amazonaws.translate#TooManyTagsException" } ], "traits": { @@ -755,6 +801,9 @@ "traits": { "smithy.api#documentation": "The encryption key for the custom terminology being imported.
" } + }, + "Tags": { + "target": "com.amazonaws.translate#TagList" } } }, @@ -798,10 +847,7 @@ } }, "com.amazonaws.translate#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.translate#InternalServerException": { "type": "structure", @@ -902,38 +948,50 @@ } }, "com.amazonaws.translate#JobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "COMPLETED_WITH_ERROR", - "name": "COMPLETED_WITH_ERROR" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "STOP_REQUESTED", - "name": "STOP_REQUESTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "COMPLETED_WITH_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED_WITH_ERROR" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.translate#Language": { @@ -1131,6 +1189,45 @@ } } }, + "com.amazonaws.translate#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.translate#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.translate#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.translate#InternalServerException" + }, + { + "target": "com.amazonaws.translate#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.translate#ResourceNotFoundException" + } + ] + }, + "com.amazonaws.translate#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.translate#ResourceArn", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.translate#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.translate#TagList" + } + } + }, "com.amazonaws.translate#ListTerminologies": { "type": "operation", "input": { @@ -1274,15 +1371,11 @@ } }, "com.amazonaws.translate#Long": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.translate#MaxResultsInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 @@ -1290,14 +1383,14 @@ } }, "com.amazonaws.translate#MergeStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OVERWRITE", - "name": "OVERWRITE" + "type": "enum", + "members": { + "OVERWRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE" } - ] + } } }, "com.amazonaws.translate#NextToken": { @@ -1382,22 +1475,26 @@ } }, "com.amazonaws.translate#ParallelDataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TSV", - "name": "TSV" - }, - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "TMX", - "name": "TMX" + "type": "enum", + "members": { + "TSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TSV" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "TMX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TMX" } - ] + } } }, "com.amazonaws.translate#ParallelDataProperties": { @@ -1514,41 +1611,58 @@ } }, "com.amazonaws.translate#ParallelDataStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.translate#Profanity": { + "type": "enum", + "members": { + "MASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASK" + } + } + } + }, + "com.amazonaws.translate#ResourceArn": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "MASK", - "name": "MASK" - } - ] + "smithy.api#length": { + "min": 1, + "max": 512 + } } }, "com.amazonaws.translate#ResourceName": { @@ -1786,6 +1900,112 @@ "smithy.api#pattern": "^[\\P{M}\\p{M}]{0,10000}$" } }, + "com.amazonaws.translate#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.translate#TagKey", + "traits": { + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.translate#TagValue", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.translate#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.translate#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.translate#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.translate#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.translate#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.translate#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.translate#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.translate#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.translate#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.translate#InternalServerException" + }, + { + "target": "com.amazonaws.translate#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.translate#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.translate#TooManyTagsException" + } + ] + }, + "com.amazonaws.translate#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.translate#ResourceArn", + "traits": { + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.translate#TagList", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.translate#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.translate#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.translate#TargetLanguageCodeStringList": { "type": "list", "member": { @@ -1793,8 +2013,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, - "max": 1 + "min": 1 } } }, @@ -1862,22 +2081,26 @@ } }, "com.amazonaws.translate#TerminologyDataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "TMX", - "name": "TMX" - }, - { - "value": "TSV", - "name": "TSV" + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "TMX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TMX" + } + }, + "TSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TSV" } - ] + } } }, "com.amazonaws.translate#TerminologyDataLocation": { @@ -2175,6 +2398,21 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.translate#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.translate#String" + }, + "ResourceArn": { + "target": "com.amazonaws.translate#ResourceArn" + } + }, + "traits": { + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.translate#TranslateText": { "type": "operation", "input": { @@ -2356,6 +2594,50 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.translate#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.translate#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.translate#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.translate#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.translate#InternalServerException" + }, + { + "target": "com.amazonaws.translate#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.translate#ResourceNotFoundException" + } + ] + }, + "com.amazonaws.translate#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.translate#ResourceArn", + "traits": { + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.translate#TagKeyList", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.translate#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.translate#UpdateParallelData": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/wafv2.json b/codegen/sdk/aws-models/wafv2.json index a2bbff3d48d..17f96892a0e 100644 --- a/codegen/sdk/aws-models/wafv2.json +++ b/codegen/sdk/aws-models/wafv2.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -31,24 +31,6 @@ "shapes": { "com.amazonaws.wafv2#AWSWAF_20190729": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "WAFV2", - "arnNamespace": "wafv2", - "cloudFormationName": "WAFv2", - "cloudTrailEventSource": "wafv2.amazonaws.com", - "endpointPrefix": "wafv2" - }, - "aws.auth#sigv4": { - "name": "wafv2" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.
\nIf you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.
\nFor information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.
\nWAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync\n GraphQL API, or an Amazon Cognito user pool. WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, the AppSync GraphQL\n API, or the Amazon Cognito user pool responds to requests either with the requested content or with an HTTP 403 status code\n (Forbidden). You also can configure CloudFront to return a custom error page when a request is\n blocked.
\nThis API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and an overview of\n how to use WAF, see the WAF Developer\n Guide.
\nYou can make calls using the endpoints listed in WAF endpoints and quotas.
\nFor regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nFor Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.
\nAlternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
\nWe currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:
\nYou use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.
You can define a web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or web ACL calls.
\nThe limits WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.
\nThis is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.
\nIf you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.
\nFor information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.
\nWAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync\n GraphQL API, or an Amazon Cognito user pool. WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, the AppSync GraphQL\n API, or the Amazon Cognito user pool responds to requests either with the requested content or with an HTTP 403 status code\n (Forbidden). You also can configure CloudFront to return a custom error page when a request is\n blocked.
\nThis API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and an overview of\n how to use WAF, see the WAF Developer\n Guide.
\nYou can make calls using the endpoints listed in WAF endpoints and quotas.
\nFor regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nFor Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.
\nAlternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
\nWe currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:
\nYou use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.
You can define a web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or web ACL calls.
\nThe limits WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.
\nThe capacity required by the rules and scope.
" } } } }, "com.amazonaws.wafv2#ComparisonOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQ", - "name": "EQ" - }, - { - "value": "NE", - "name": "NE" - }, - { - "value": "LE", - "name": "LE" - }, - { - "value": "LT", - "name": "LT" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "GT", - "name": "GT" - } - ] + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + } } }, "com.amazonaws.wafv2#Condition": { @@ -621,6 +648,7 @@ "com.amazonaws.wafv2#ConsumedCapacity": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -711,1492 +739,2948 @@ "type": "string" }, "com.amazonaws.wafv2#CountryCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AF", - "name": "AF" - }, - { - "value": "AX", - "name": "AX" - }, - { - "value": "AL", - "name": "AL" - }, - { - "value": "DZ", - "name": "DZ" - }, - { - "value": "AS", - "name": "AS" - }, - { - "value": "AD", - "name": "AD" - }, - { - "value": "AO", - "name": "AO" - }, - { - "value": "AI", - "name": "AI" - }, - { - "value": "AQ", - "name": "AQ" - }, - { - "value": "AG", - "name": "AG" - }, - { - "value": "AR", - "name": "AR" - }, - { - "value": "AM", - "name": "AM" - }, - { - "value": "AW", - "name": "AW" - }, - { - "value": "AU", - "name": "AU" - }, - { - "value": "AT", - "name": "AT" - }, - { - "value": "AZ", - "name": "AZ" - }, - { - "value": "BS", - "name": "BS" - }, - { - "value": "BH", - "name": "BH" - }, - { - "value": "BD", - "name": "BD" - }, - { - "value": "BB", - "name": "BB" - }, - { - "value": "BY", - "name": "BY" - }, - { - "value": "BE", - "name": "BE" - }, - { - "value": "BZ", - "name": "BZ" - }, - { - "value": "BJ", - "name": "BJ" - }, - { - "value": "BM", - "name": "BM" - }, - { - "value": "BT", - "name": "BT" - }, - { - "value": "BO", - "name": "BO" - }, - { - "value": "BQ", - "name": "BQ" - }, - { - "value": "BA", - "name": "BA" - }, - { - "value": "BW", - "name": "BW" - }, - { - "value": "BV", - "name": "BV" - }, - { - "value": "BR", - "name": "BR" - }, - { - "value": "IO", - "name": "IO" - }, - { - "value": "BN", - "name": "BN" - }, - { - "value": "BG", - "name": "BG" - }, - { - "value": "BF", - "name": "BF" - }, - { - "value": "BI", - "name": "BI" - }, - { - "value": "KH", - "name": "KH" - }, - { - "value": "CM", - "name": "CM" - }, - { - "value": "CA", - "name": "CA" - }, - { - "value": "CV", - "name": "CV" - }, - { - "value": "KY", - "name": "KY" - }, - { - "value": "CF", - "name": "CF" - }, - { - "value": "TD", - "name": "TD" - }, - { - "value": "CL", - "name": "CL" - }, - { - "value": "CN", - "name": "CN" - }, - { - "value": "CX", - "name": "CX" - }, - { - "value": "CC", - "name": "CC" - }, - { - "value": "CO", - "name": "CO" - }, - { - "value": "KM", - "name": "KM" - }, - { - "value": "CG", - "name": "CG" - }, - { - "value": "CD", - "name": "CD" - }, - { - "value": "CK", - "name": "CK" - }, - { - "value": "CR", - "name": "CR" - }, - { - "value": "CI", - "name": "CI" - }, - { - "value": "HR", - "name": "HR" - }, - { - "value": "CU", - "name": "CU" - }, - { - "value": "CW", - "name": "CW" - }, - { - "value": "CY", - "name": "CY" - }, - { - "value": "CZ", - "name": "CZ" - }, - { - "value": "DK", - "name": "DK" - }, - { - "value": "DJ", - "name": "DJ" - }, - { - "value": "DM", - "name": "DM" - }, - { - "value": "DO", - "name": "DO" - }, - { - "value": "EC", - "name": "EC" - }, - { - "value": "EG", - "name": "EG" - }, - { - "value": "SV", - "name": "SV" - }, - { - "value": "GQ", - "name": "GQ" - }, - { - "value": "ER", - "name": "ER" - }, - { - "value": "EE", - "name": "EE" - }, - { - "value": "ET", - "name": "ET" - }, - { - "value": "FK", - "name": "FK" - }, - { - "value": "FO", - "name": "FO" - }, - { - "value": "FJ", - "name": "FJ" - }, - { - "value": "FI", - "name": "FI" - }, - { - "value": "FR", - "name": "FR" - }, - { - "value": "GF", - "name": "GF" - }, - { - "value": "PF", - "name": "PF" - }, - { - "value": "TF", - "name": "TF" - }, - { - "value": "GA", - "name": "GA" - }, - { - "value": "GM", - "name": "GM" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "DE", - "name": "DE" - }, - { - "value": "GH", - "name": "GH" - }, - { - "value": "GI", - "name": "GI" - }, - { - "value": "GR", - "name": "GR" - }, - { - "value": "GL", - "name": "GL" - }, - { - "value": "GD", - "name": "GD" - }, - { - "value": "GP", - "name": "GP" - }, - { - "value": "GU", - "name": "GU" - }, - { - "value": "GT", - "name": "GT" - }, - { - "value": "GG", - "name": "GG" - }, - { - "value": "GN", - "name": "GN" - }, - { - "value": "GW", - "name": "GW" - }, - { - "value": "GY", - "name": "GY" - }, - { - "value": "HT", - "name": "HT" - }, - { - "value": "HM", - "name": "HM" - }, - { - "value": "VA", - "name": "VA" - }, - { - "value": "HN", - "name": "HN" - }, - { - "value": "HK", - "name": "HK" - }, - { - "value": "HU", - "name": "HU" - }, - { - "value": "IS", - "name": "IS" - }, - { - "value": "IN", - "name": "IN" - }, - { - "value": "ID", - "name": "ID" - }, - { - "value": "IR", - "name": "IR" - }, - { - "value": "IQ", - "name": "IQ" - }, - { - "value": "IE", - "name": "IE" - }, - { - "value": "IM", - "name": "IM" - }, - { - "value": "IL", - "name": "IL" - }, - { - "value": "IT", - "name": "IT" - }, - { - "value": "JM", - "name": "JM" - }, - { - "value": "JP", - "name": "JP" - }, - { - "value": "JE", - "name": "JE" - }, - { - "value": "JO", - "name": "JO" - }, - { - "value": "KZ", - "name": "KZ" - }, - { - "value": "KE", - "name": "KE" - }, - { - "value": "KI", - "name": "KI" - }, - { - "value": "KP", - "name": "KP" - }, - { - "value": "KR", - "name": "KR" - }, - { - "value": "KW", - "name": "KW" - }, - { - "value": "KG", - "name": "KG" - }, - { - "value": "LA", - "name": "LA" - }, - { - "value": "LV", - "name": "LV" - }, - { - "value": "LB", - "name": "LB" - }, - { - "value": "LS", - "name": "LS" - }, - { - "value": "LR", - "name": "LR" - }, - { - "value": "LY", - "name": "LY" - }, - { - "value": "LI", - "name": "LI" - }, - { - "value": "LT", - "name": "LT" - }, - { - "value": "LU", - "name": "LU" - }, - { - "value": "MO", - "name": "MO" - }, - { - "value": "MK", - "name": "MK" - }, - { - "value": "MG", - "name": "MG" - }, - { - "value": "MW", - "name": "MW" - }, - { - "value": "MY", - "name": "MY" - }, - { - "value": "MV", - "name": "MV" - }, - { - "value": "ML", - "name": "ML" - }, - { - "value": "MT", - "name": "MT" - }, - { - "value": "MH", - "name": "MH" - }, - { - "value": "MQ", - "name": "MQ" - }, - { - "value": "MR", - "name": "MR" - }, - { - "value": "MU", - "name": "MU" - }, - { - "value": "YT", - "name": "YT" - }, - { - "value": "MX", - "name": "MX" - }, - { - "value": "FM", - "name": "FM" - }, - { - "value": "MD", - "name": "MD" - }, - { - "value": "MC", - "name": "MC" - }, - { - "value": "MN", - "name": "MN" - }, - { - "value": "ME", - "name": "ME" - }, - { - "value": "MS", - "name": "MS" - }, - { - "value": "MA", - "name": "MA" - }, - { - "value": "MZ", - "name": "MZ" - }, - { - "value": "MM", - "name": "MM" - }, - { - "value": "NA", - "name": "NA" - }, - { - "value": "NR", - "name": "NR" - }, - { - "value": "NP", - "name": "NP" - }, - { - "value": "NL", - "name": "NL" - }, - { - "value": "NC", - "name": "NC" - }, - { - "value": "NZ", - "name": "NZ" - }, - { - "value": "NI", - "name": "NI" - }, - { - "value": "NE", - "name": "NE" - }, - { - "value": "NG", - "name": "NG" - }, - { - "value": "NU", - "name": "NU" - }, - { - "value": "NF", - "name": "NF" - }, - { - "value": "MP", - "name": "MP" - }, - { - "value": "NO", - "name": "NO" - }, - { - "value": "OM", - "name": "OM" - }, - { - "value": "PK", - "name": "PK" - }, - { - "value": "PW", - "name": "PW" - }, - { - "value": "PS", - "name": "PS" - }, - { - "value": "PA", - "name": "PA" - }, - { - "value": "PG", - "name": "PG" - }, - { - "value": "PY", - "name": "PY" - }, - { - "value": "PE", - "name": "PE" - }, - { - "value": "PH", - "name": "PH" - }, - { - "value": "PN", - "name": "PN" - }, - { - "value": "PL", - "name": "PL" - }, - { - "value": "PT", - "name": "PT" - }, - { - "value": "PR", - "name": "PR" - }, - { - "value": "QA", - "name": "QA" - }, - { - "value": "RE", - "name": "RE" - }, - { - "value": "RO", - "name": "RO" - }, - { - "value": "RU", - "name": "RU" - }, - { - "value": "RW", - "name": "RW" - }, - { - "value": "BL", - "name": "BL" - }, - { - "value": "SH", - "name": "SH" - }, - { - "value": "KN", - "name": "KN" - }, - { - "value": "LC", - "name": "LC" - }, - { - "value": "MF", - "name": "MF" - }, - { - "value": "PM", - "name": "PM" - }, - { - "value": "VC", - "name": "VC" - }, - { - "value": "WS", - "name": "WS" - }, - { - "value": "SM", - "name": "SM" - }, - { - "value": "ST", - "name": "ST" - }, - { - "value": "SA", - "name": "SA" - }, - { - "value": "SN", - "name": "SN" - }, - { - "value": "RS", - "name": "RS" - }, - { - "value": "SC", - "name": "SC" - }, - { - "value": "SL", - "name": "SL" - }, - { - "value": "SG", - "name": "SG" - }, - { - "value": "SX", - "name": "SX" - }, - { - "value": "SK", - "name": "SK" - }, - { - "value": "SI", - "name": "SI" - }, - { - "value": "SB", - "name": "SB" - }, - { - "value": "SO", - "name": "SO" - }, - { - "value": "ZA", - "name": "ZA" - }, - { - "value": "GS", - "name": "GS" - }, - { - "value": "SS", - "name": "SS" - }, - { - "value": "ES", - "name": "ES" - }, - { - "value": "LK", - "name": "LK" - }, - { - "value": "SD", - "name": "SD" - }, - { - "value": "SR", - "name": "SR" - }, - { - "value": "SJ", - "name": "SJ" - }, - { - "value": "SZ", - "name": "SZ" - }, - { - "value": "SE", - "name": "SE" - }, - { - "value": "CH", - "name": "CH" - }, - { - "value": "SY", - "name": "SY" - }, - { - "value": "TW", - "name": "TW" - }, - { - "value": "TJ", - "name": "TJ" - }, - { - "value": "TZ", - "name": "TZ" - }, - { - "value": "TH", - "name": "TH" - }, - { - "value": "TL", - "name": "TL" - }, - { - "value": "TG", - "name": "TG" - }, - { - "value": "TK", - "name": "TK" - }, - { - "value": "TO", - "name": "TO" - }, - { - "value": "TT", - "name": "TT" - }, - { - "value": "TN", - "name": "TN" - }, - { - "value": "TR", - "name": "TR" - }, - { - "value": "TM", - "name": "TM" - }, - { - "value": "TC", - "name": "TC" - }, - { - "value": "TV", - "name": "TV" - }, - { - "value": "UG", - "name": "UG" - }, - { - "value": "UA", - "name": "UA" - }, - { - "value": "AE", - "name": "AE" - }, - { - "value": "GB", - "name": "GB" - }, - { - "value": "US", - "name": "US" - }, - { - "value": "UM", - "name": "UM" - }, - { - "value": "UY", - "name": "UY" - }, - { - "value": "UZ", - "name": "UZ" - }, - { - "value": "VU", - "name": "VU" - }, - { - "value": "VE", - "name": "VE" - }, - { - "value": "VN", - "name": "VN" - }, - { - "value": "VG", - "name": "VG" - }, - { - "value": "VI", - "name": "VI" - }, - { - "value": "WF", - "name": "WF" - }, - { - "value": "EH", - "name": "EH" - }, - { - "value": "YE", - "name": "YE" - }, - { - "value": "ZM", - "name": "ZM" - }, - { - "value": "ZW", - "name": "ZW" - }, - { - "value": "XK", - "name": "XK" - } - ] - } - }, - "com.amazonaws.wafv2#CountryCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#CountryCode" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#CreateIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CreateIPSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CreateIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + "type": "enum", + "members": { + "AF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AF" + } }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" + "AX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AX" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + "AL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "DZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DZ" + } }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + "AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS" + } }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + "AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD" + } }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" + "AO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AO" + } }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an IPSet, which you use to identify web requests that\n originate from specific IP addresses or ranges of IP addresses. For example, if you're\n receiving a lot of requests from a ranges of IP addresses, you can configure WAF to\n block them using an IPSet that lists those IP addresses.
" - } - }, - "com.amazonaws.wafv2#CreateIPSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "AI": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA description of the IP set that helps with identification.
" + "smithy.api#enumValue": "AG" } }, - "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion", + "AR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the IP addresses, either IPV4 or IPV6.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExample address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
An array of key:value pairs to associate with the resource.
" + "smithy.api#enumValue": "AW" } - } - } - }, - "com.amazonaws.wafv2#CreateIPSetResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#IPSetSummary", + }, + "AU": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request\n component for the specified patterns.
" - } - }, - "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "BY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the set. You cannot change the name after you create the set.
", - "smithy.api#required": {} + "smithy.api#enumValue": "BY" } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "BE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA description of the set that helps with identification.
" + "smithy.api#enumValue": "BZ" } }, - "RegularExpressionList": { - "target": "com.amazonaws.wafv2#RegularExpressionList", + "BJ": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Array of regular expression strings.
", - "smithy.api#required": {} + "smithy.api#enumValue": "BJ" } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", + "BM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An array of key:value pairs to associate with the resource.
" + "smithy.api#enumValue": "BM" } - } - } - }, - "com.amazonaws.wafv2#CreateRegexPatternSetResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#RegexPatternSetSummary", + }, + "BT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
Creates a RuleGroup per the specifications provided.
\nA rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" - } - }, - "com.amazonaws.wafv2#CreateRuleGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "BF": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
", - "smithy.api#required": {} + "smithy.api#enumValue": "BF" } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "BI": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", - "smithy.api#required": {} + "smithy.api#enumValue": "KH" } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "CM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A description of the rule group that helps with identification.
" + "smithy.api#enumValue": "CM" } }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", + "CA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#enumValue": "CA" } }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", + "CV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Defines and enables Amazon CloudWatch metrics and web request sample collection.
", - "smithy.api#required": {} + "smithy.api#enumValue": "CV" } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", + "KY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An array of key:value pairs to associate with the resource.
" + "smithy.api#enumValue": "KY" } }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", + "CF": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#enumValue": "CF" } - } - } - }, - "com.amazonaws.wafv2#CreateRuleGroupResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#RuleGroupSummary", + }, + "TD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
Creates a WebACL per the specifications provided.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
" - } - }, - "com.amazonaws.wafv2#CreateWebACLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "HR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the web ACL. You cannot change the name of a web ACL after you create it.
", - "smithy.api#required": {} + "smithy.api#enumValue": "HR" } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "CU": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe action to perform if none of the Rules contained in the WebACL match.
A description of the web ACL that helps with identification.
" + "smithy.api#enumValue": "CY" } }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", + "CZ": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#enumValue": "CZ" } }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", + "DK": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Defines and enables Amazon CloudWatch metrics and web request sample collection.
", - "smithy.api#required": {} + "smithy.api#enumValue": "DK" } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", + "DJ": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An array of key:value pairs to associate with the resource.
" + "smithy.api#enumValue": "DJ" } }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", + "DM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#enumValue": "DM" } }, - "CaptchaConfig": { - "target": "com.amazonaws.wafv2#CaptchaConfig", + "DO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.
The name of the custom header.
\nFor custom request header insertion, when WAF inserts the header into the request,\n it prefixes this name x-amzn-waf-, to avoid confusion with the headers that\n are already in the request. For example, for the header name sample, WAF\n inserts the header x-amzn-waf-sample.
The value of the custom header.
", - "smithy.api#required": {} + "smithy.api#enumValue": "SV" } - } - }, - "traits": { - "smithy.api#documentation": "A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.
" - } - }, - "com.amazonaws.wafv2#CustomHTTPHeaderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9._$-]+$" - } - }, - "com.amazonaws.wafv2#CustomHTTPHeaderValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 + "GQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GQ" + } }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.wafv2#CustomHTTPHeaders": { + "ER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ER" + } + }, + "EE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EE" + } + }, + "ET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ET" + } + }, + "FK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FK" + } + }, + "FO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FO" + } + }, + "FJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FJ" + } + }, + "FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "GF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GF" + } + }, + "PF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PF" + } + }, + "TF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TF" + } + }, + "GA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GA" + } + }, + "GM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GM" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "GH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GH" + } + }, + "GI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GI" + } + }, + "GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GR" + } + }, + "GL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GL" + } + }, + "GD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GD" + } + }, + "GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GP" + } + }, + "GU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GU" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GG" + } + }, + "GN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GN" + } + }, + "GW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GW" + } + }, + "GY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GY" + } + }, + "HT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HT" + } + }, + "HM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HM" + } + }, + "VA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VA" + } + }, + "HN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HN" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + }, + "HU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HU" + } + }, + "IS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IS" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IR" + } + }, + "IQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IQ" + } + }, + "IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IE" + } + }, + "IM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IM" + } + }, + "IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IL" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "JM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JM" + } + }, + "JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JP" + } + }, + "JE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JE" + } + }, + "JO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JO" + } + }, + "KZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KZ" + } + }, + "KE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KE" + } + }, + "KI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KI" + } + }, + "KP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KP" + } + }, + "KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KR" + } + }, + "KW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KW" + } + }, + "KG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KG" + } + }, + "LA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LA" + } + }, + "LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LV" + } + }, + "LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LB" + } + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + }, + "LR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LR" + } + }, + "LY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LY" + } + }, + "LI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LI" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LU" + } + }, + "MO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MO" + } + }, + "MK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MK" + } + }, + "MG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MG" + } + }, + "MW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MW" + } + }, + "MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MY" + } + }, + "MV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MV" + } + }, + "ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ML" + } + }, + "MT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MT" + } + }, + "MH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MH" + } + }, + "MQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MQ" + } + }, + "MR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MR" + } + }, + "MU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MU" + } + }, + "YT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YT" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "FM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FM" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + }, + "MC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MC" + } + }, + "MN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MN" + } + }, + "ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ME" + } + }, + "MS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS" + } + }, + "MA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MA" + } + }, + "MZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MZ" + } + }, + "MM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MM" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NA" + } + }, + "NR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NR" + } + }, + "NP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NP" + } + }, + "NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NL" + } + }, + "NC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NC" + } + }, + "NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NZ" + } + }, + "NI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NI" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "NG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NG" + } + }, + "NU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NU" + } + }, + "NF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NF" + } + }, + "MP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MP" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "OM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OM" + } + }, + "PK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PK" + } + }, + "PW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PW" + } + }, + "PS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PS" + } + }, + "PA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PA" + } + }, + "PG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PG" + } + }, + "PY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PY" + } + }, + "PE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PE" + } + }, + "PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PH" + } + }, + "PN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PN" + } + }, + "PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PL" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "PR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PR" + } + }, + "QA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QA" + } + }, + "RE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RE" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RO" + } + }, + "RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "BL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BL" + } + }, + "SH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SH" + } + }, + "KN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KN" + } + }, + "LC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LC" + } + }, + "MF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MF" + } + }, + "PM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PM" + } + }, + "VC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VC" + } + }, + "WS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WS" + } + }, + "SM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM" + } + }, + "ST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ST" + } + }, + "SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SA" + } + }, + "SN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SN" + } + }, + "RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS" + } + }, + "SC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SC" + } + }, + "SL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SL" + } + }, + "SG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG" + } + }, + "SX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SX" + } + }, + "SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SK" + } + }, + "SI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SI" + } + }, + "SB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SB" + } + }, + "SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SO" + } + }, + "ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZA" + } + }, + "GS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GS" + } + }, + "SS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SS" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "LK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LK" + } + }, + "SD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SD" + } + }, + "SR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SR" + } + }, + "SJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SJ" + } + }, + "SZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SZ" + } + }, + "SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE" + } + }, + "CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CH" + } + }, + "SY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SY" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "TJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TJ" + } + }, + "TZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TZ" + } + }, + "TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TH" + } + }, + "TL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TL" + } + }, + "TG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TG" + } + }, + "TK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TK" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "TT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TT" + } + }, + "TN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TN" + } + }, + "TR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TR" + } + }, + "TM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TM" + } + }, + "TC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TC" + } + }, + "TV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TV" + } + }, + "UG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UG" + } + }, + "UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UA" + } + }, + "AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AE" + } + }, + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + }, + "UM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UM" + } + }, + "UY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UY" + } + }, + "UZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UZ" + } + }, + "VU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VU" + } + }, + "VE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VE" + } + }, + "VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VN" + } + }, + "VG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VG" + } + }, + "VI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VI" + } + }, + "WF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WF" + } + }, + "EH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EH" + } + }, + "YE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YE" + } + }, + "ZM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZM" + } + }, + "ZW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZW" + } + }, + "XK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XK" + } + } + } + }, + "com.amazonaws.wafv2#CountryCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#CountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CreateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an IPSet, which you use to identify web requests that\n originate from specific IP addresses or ranges of IP addresses. For example, if you're\n receiving a lot of requests from a ranges of IP addresses, you can configure WAF to\n block them using an IPSet that lists those IP addresses.
" + } + }, + "com.amazonaws.wafv2#CreateIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA description of the IP set that helps with identification.
" + } + }, + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "The version of the IP addresses, either IPV4 or IPV6.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
An array of key:value pairs to associate with the resource.
" + } + } + } + }, + "com.amazonaws.wafv2#CreateIPSetResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#IPSetSummary", + "traits": { + "smithy.api#documentation": "High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request\n component for the specified patterns.
" + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the set. You cannot change the name after you create the set.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA description of the set that helps with identification.
" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "Array of regular expression strings.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "An array of key:value pairs to associate with the resource.
" + } + } + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSetResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummary", + "traits": { + "smithy.api#documentation": "High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
Creates a RuleGroup per the specifications provided.
\nA rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" + } + }, + "com.amazonaws.wafv2#CreateRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the rule group that helps with identification.
" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "Defines and enables Amazon CloudWatch metrics and web request sample collection.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "An array of key:value pairs to associate with the resource.
" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + } + } + } + }, + "com.amazonaws.wafv2#CreateRuleGroupResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#RuleGroupSummary", + "traits": { + "smithy.api#documentation": "High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
Creates a WebACL per the specifications provided.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
" + } + }, + "com.amazonaws.wafv2#CreateWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the web ACL. You cannot change the name of a web ACL after you create it.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe action to perform if none of the Rules contained in the WebACL match.
A description of the web ACL that helps with identification.
" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "Defines and enables Amazon CloudWatch metrics and web request sample collection.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "An array of key:value pairs to associate with the resource.
" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.
The name of the custom header.
\nFor custom request header insertion, when WAF inserts the header into the request,\n it prefixes this name x-amzn-waf-, to avoid confusion with the headers that\n are already in the request. For example, for the header name sample, WAF\n inserts the header x-amzn-waf-sample.
The value of the custom header.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.
" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._$-]+$" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#CustomHTTPHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CustomRequestHandling": { + "type": "structure", + "members": { + "InsertHeaders": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaders", + "traits": { + "smithy.api#documentation": "The HTTP headers to insert into the request. Duplicate header names are not allowed.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Custom request handling behavior that inserts custom headers into a web request. You can\n add custom request handling for the rule actions allow and count.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
" + } + }, + "com.amazonaws.wafv2#CustomResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseStatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status code to return to the client.
\nFor a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the \n WAF Developer Guide.
", + "smithy.api#required": {} + } + }, + "CustomResponseBodyKey": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "References the response body that you want WAF to return to the web request\n client. You can define a custom response for a rule action or a default web ACL action that\n is set to block. To do this, you first define the response body key and value in the\n CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL\n default action BlockAction setting, you reference the response body using this\n key.
The HTTP headers to use in the response. Duplicate header names are not allowed.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A custom response to send to the client. You can define a custom response for rule\n actions and default web ACL actions that are set to BlockAction.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
" + } + }, + "com.amazonaws.wafv2#CustomResponseBodies": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#EntityName" + }, + "value": { + "target": "com.amazonaws.wafv2#CustomResponseBody" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CustomResponseBody": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.wafv2#ResponseContentType", + "traits": { + "smithy.api#documentation": "The type of content in the payload that you are defining in the Content\n string.
The payload of the custom response.
\nYou can use JSON escape strings in JSON content. To do this, you must specify JSON\n content in the ContentType setting.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response body to use in a custom response to a web request. This is referenced by\n key from CustomResponse\n CustomResponseBodyKey.
Specifies that WAF should block requests by default.
" + } + }, + "Allow": { + "target": "com.amazonaws.wafv2#AllowAction", + "traits": { + "smithy.api#documentation": "Specifies that WAF should allow requests by default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "In a WebACL, this is the action that you want WAF to perform\n when a web request doesn't match any of the rules in the WebACL. The default\n action must be a terminating action.
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
\nYou can only use this if ManagedByFirewallManager is false in the specified\n WebACL.
The Amazon Resource Name (ARN) of the web ACL.
", + "smithy.api#required": {} + } + }, + "WebACLLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Deletes the specified IPSet.
" + } + }, + "com.amazonaws.wafv2#DeleteIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Deletes the LoggingConfiguration from the specified web ACL.
" + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.wafv2#DeletePermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeletePermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeletePermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "Permanently deletes an IAM policy from the specified rule group.
\nYou must be the owner of the rule group to perform this operation.
" + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule group from which you want to delete the\n policy.
\nYou must be the owner of the rule group to perform this operation.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.wafv2#DeleteRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified RegexPatternSet.
" + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the set. You cannot change the name after you create the set.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Deletes the specified RuleGroup.
" + } + }, + "com.amazonaws.wafv2#DeleteRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Deletes the specified WebACL.
\nYou can only use this if ManagedByFirewallManager is false in the specified\n WebACL.
Before deleting any web ACL, first disassociate it from all resources.
\nTo retrieve a list of the resources that are associated with a web ACL, use the\n following calls:
\nFor regional resources, call ListResourcesForWebACL.
\nFor Amazon CloudFront distributions, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId.
To disassociate a resource from a web ACL, use the following calls:
\nFor regional resources, call DisassociateWebACL.
\nFor Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.
The name of the web ACL. You cannot change the name of a web ACL after you create it.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Provides high-level information for a managed rule group, including descriptions of the\n rules.
" + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe version of the rule group. You can only use a version that is not scheduled for\n expiration. If you don't provide this, WAF uses the vendor's default version.
" + } + } + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse": { + "type": "structure", + "members": { + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "The managed rule group's version.
" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.
" + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL\n capacity units (WCU) to calculate and control the operating resources that are used to run\n your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule\n type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so\n users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web\n ACLs is 1,500.
" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#RuleSummaries", + "traits": { + "smithy.api#documentation": "" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.
The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nFor Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The name of the rule whose action you want to override to Count.
Specifies a single rule in a rule group whose action you want to override to\n Count. When you exclude a rule, WAF evaluates it exactly as it would if\n the rule action setting were Count. This is a useful option for testing the\n rules in a rule group without modifying how they handle your web traffic.
Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.
Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n
Alternately, you can filter and inspect all headers with the Headers\n FieldToMatch setting.
Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.
\nExample JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n
Inspect all query arguments.
" + } + }, + "UriPath": { + "target": "com.amazonaws.wafv2#UriPath", + "traits": { + "smithy.api#documentation": "Inspect the request URI path. This is the part of the web request that identifies a\n resource, for example, /images/daily-ad.jpg.
Inspect the query string. This is the part of a URL that appears after a ?\n character, if any.
Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nOnly the first 8 KB (8192 bytes) of the request body are forwarded to WAF for\n inspection by the underlying host service. For information about how to handle oversized\n request bodies, see the Body object configuration.
Inspect the HTTP method. The method indicates the type of operation that the request is\n asking the origin to perform.
" + } + }, + "JsonBody": { + "target": "com.amazonaws.wafv2#JsonBody", + "traits": { + "smithy.api#documentation": "Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nOnly the first 8 KB (8192 bytes) of the request body are forwarded to WAF for\n inspection by the underlying host service. For information about how to handle oversized\n request bodies, see the JsonBody object configuration.
Inspect the request headers. You must configure scope and pattern matching filters in\n the Headers object, to define the set of headers to and the parts of the\n headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize header content in the Headers object.\n WAF applies the pattern matching filters to the headers that it receives from the\n underlying host service.
Inspect the request cookies. You must configure scope and pattern matching filters in\n the Cookies object, to define the set of cookies and the parts of the cookies\n that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize cookie content in the Cookies object.\n WAF applies the pattern matching filters to the cookies that it receives from the\n underlying host service.
The part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.
Example JSON for a QueryString field to match:
\n \"FieldToMatch\": { \"QueryString\": {} }\n
Example JSON for a Method field to match specification:
\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n
How to handle logs that satisfy the filter's conditions and requirement.
", + "smithy.api#required": {} + } + }, + "Requirement": { + "target": "com.amazonaws.wafv2#FilterRequirement", + "traits": { + "smithy.api#documentation": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy\n the filter, a log must match all conditions or must match at least one condition.
", + "smithy.api#required": {} + } + }, + "Conditions": { + "target": "com.amazonaws.wafv2#Conditions", + "traits": { + "smithy.api#documentation": "Match conditions for the filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A single logging filter, used in LoggingFilter.
" + } + }, + "com.amazonaws.wafv2#FilterBehavior": { + "type": "enum", + "members": { + "KEEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP" + } + }, + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + } + } + }, + "com.amazonaws.wafv2#FilterRequirement": { + "type": "enum", + "members": { + "MEETS_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEETS_ALL" + } + }, + "MEETS_ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEETS_ANY" + } + } + } + }, + "com.amazonaws.wafv2#Filters": { "type": "list", "member": { - "target": "com.amazonaws.wafv2#CustomHTTPHeader" + "target": "com.amazonaws.wafv2#Filter" }, "traits": { "smithy.api#length": { @@ -2204,111 +3688,283 @@ } } }, - "com.amazonaws.wafv2#CustomRequestHandling": { + "com.amazonaws.wafv2#FirewallManagerRuleGroup": { "type": "structure", "members": { - "InsertHeaders": { - "target": "com.amazonaws.wafv2#CustomHTTPHeaders", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The HTTP headers to insert into the request. Duplicate header names are not allowed.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
", + "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.wafv2#RulePriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "If you define more than one rule group in the first or last Firewall Manager rule groups, WAF\n evaluates each request against the rule groups in order, starting from the lowest priority\n setting. The priorities don't need to be consecutive, but they must all be\n different.
", + "smithy.api#required": {} + } + }, + "FirewallManagerStatement": { + "target": "com.amazonaws.wafv2#FirewallManagerStatement", + "traits": { + "smithy.api#documentation": "The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
", + "smithy.api#required": {} + } + }, + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", + "traits": { + "smithy.api#documentation": "The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
\nYou can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.
\nDefines and enables Amazon CloudWatch metrics and web request sample collection.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Custom request handling behavior that inserts custom headers into a web request. You can\n add custom request handling for the rule actions allow and count.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
" + "smithy.api#documentation": "A rule group that's defined for an Firewall Manager WAF policy.
" } }, - "com.amazonaws.wafv2#CustomResponse": { + "com.amazonaws.wafv2#FirewallManagerRuleGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroup" + } + }, + "com.amazonaws.wafv2#FirewallManagerStatement": { "type": "structure", "members": { - "ResponseCode": { - "target": "com.amazonaws.wafv2#ResponseStatusCode", + "ManagedRuleGroupStatement": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", "traits": { - "smithy.api#documentation": "The HTTP status code to return to the client.
\nFor a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the \n WAF Developer Guide.
", - "smithy.api#required": {} + "smithy.api#documentation": "A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
References the response body that you want WAF to return to the web request\n client. You can define a custom response for a rule action or a default web ACL action that\n is set to block. To do this, you first define the response body key and value in the\n CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL\n default action BlockAction setting, you reference the response body using this\n key.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
\nYou cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
" + } + }, + "com.amazonaws.wafv2#ForwardedIPConfig": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "traits": { + "smithy.api#documentation": "The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe HTTP headers to use in the response. Duplicate header names are not allowed.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
" + "smithy.api#documentation": "The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
A custom response to send to the client. You can define a custom response for rule\n actions and default web ACL actions that are set to BlockAction.
\nFor information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.
" + "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.
\nWAF only evaluates the first IP address found in the specified HTTP header.\n
" } }, - "com.amazonaws.wafv2#CustomResponseBodies": { - "type": "map", - "key": { - "target": "com.amazonaws.wafv2#EntityName" + "com.amazonaws.wafv2#ForwardedIPHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.wafv2#ForwardedIPPosition": { + "type": "enum", + "members": { + "FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRST" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest" }, - "value": { - "target": "com.amazonaws.wafv2#CustomResponseBody" + "output": { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse" }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], "traits": { - "smithy.api#length": { - "min": 1 + "smithy.api#documentation": "Generates a presigned download URL for the specified release of the mobile SDK.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "The device platform.
", + "smithy.api#required": {} + } + }, + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "The release version. For the latest available version, specify\n LATEST.
The type of content in the payload that you are defining in the Content\n string.
The presigned download URL for the specified SDK release.
" + } + } + } + }, + "com.amazonaws.wafv2#GeoMatchStatement": { + "type": "structure", + "members": { + "CountryCodes": { + "target": "com.amazonaws.wafv2#CountryCodes", + "traits": { + "smithy.api#documentation": "An array of two-character country codes, for example, [ \"US\", \"CN\" ], from\n the alpha-2 country ISO codes of the ISO 3166 international standard.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nA rule statement used to identify web requests based on country of origin.
" + } + }, + "com.amazonaws.wafv2#GetIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified IPSet.
" + } + }, + "com.amazonaws.wafv2#GetIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe payload of the custom response.
\nYou can use JSON escape strings in JSON content. To do this, you must specify JSON\n content in the ContentType setting.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.
", + "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "The response body to use in a custom response to a web request. This is referenced by\n key from CustomResponse\n CustomResponseBodyKey.
Specifies that WAF should block requests by default.
" + "smithy.api#documentation": "" } }, - "Allow": { - "target": "com.amazonaws.wafv2#AllowAction", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "Specifies that WAF should allow requests by default.
" + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
In a WebACL, this is the action that you want WAF to perform\n when a web request doesn't match any of the rules in the WebACL. The default\n action must be a terminating action, so you can't use count.
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
\nYou can only use this if ManagedByFirewallManager is false in the specified\n WebACL.
Returns the LoggingConfiguration for the specified web ACL.
" } }, - "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { + "com.amazonaws.wafv2#GetLoggingConfigurationRequest": { "type": "structure", "members": { - "WebACLArn": { + "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL.
", - "smithy.api#required": {} - } - }, - "WebACLLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
", "smithy.api#required": {} } } } }, - "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse": { + "com.amazonaws.wafv2#GetLoggingConfigurationResponse": { "type": "structure", "members": { - "NextWebACLLockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The LoggingConfiguration for the specified web ACL.
" } } } }, - "com.amazonaws.wafv2#DeleteIPSet": { + "com.amazonaws.wafv2#GetManagedRuleSet": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#DeleteIPSetRequest" + "target": "com.amazonaws.wafv2#GetManagedRuleSetRequest" }, "output": { - "target": "com.amazonaws.wafv2#DeleteIPSetResponse" + "target": "com.amazonaws.wafv2#GetManagedRuleSetResponse" }, "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, { "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, @@ -2384,28 +4027,19 @@ }, { "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" } ], "traits": { - "smithy.api#documentation": "Deletes the specified IPSet.
" + "smithy.api#documentation": "Retrieves the specified managed rule set.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", "smithy.api#required": {} } }, @@ -2419,30 +4053,36 @@ "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#documentation": "A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
The managed rule set that you requested.
" + } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Deletes the LoggingConfiguration from the specified web ACL.
" + "smithy.api#documentation": "Retrieves information for the specified mobile SDK release, including release notes and\n tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" } }, - "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest": { + "com.amazonaws.wafv2#GetMobileSdkReleaseRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", + "Platform": { + "target": "com.amazonaws.wafv2#Platform", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
", + "smithy.api#documentation": "The device platform.
", + "smithy.api#required": {} + } + }, + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "The release version. For the latest available version, specify\n LATEST.
Information for a specified SDK release, including release notes and tags.
" + } + } + } }, - "com.amazonaws.wafv2#DeletePermissionPolicy": { + "com.amazonaws.wafv2#GetPermissionPolicy": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#DeletePermissionPolicyRequest" + "target": "com.amazonaws.wafv2#GetPermissionPolicyRequest" }, "output": { - "target": "com.amazonaws.wafv2#DeletePermissionPolicyResponse" + "target": "com.amazonaws.wafv2#GetPermissionPolicyResponse" }, "errors": [ { @@ -2501,37 +4152,41 @@ } ], "traits": { - "smithy.api#documentation": "Permanently deletes an IAM policy from the specified rule group.
\nYou must be the owner of the rule group to perform this operation.
" + "smithy.api#documentation": "Returns the IAM policy that is attached to the specified rule group.
\nYou must be the owner of the rule group to perform this operation.
" } }, - "com.amazonaws.wafv2#DeletePermissionPolicyRequest": { + "com.amazonaws.wafv2#GetPermissionPolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule group from which you want to delete the\n policy.
\nYou must be the owner of the rule group to perform this operation.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule group for which you want to get the\n policy.
", "smithy.api#required": {} } } } }, - "com.amazonaws.wafv2#DeletePermissionPolicyResponse": { + "com.amazonaws.wafv2#GetPermissionPolicyResponse": { "type": "structure", - "members": {} + "members": { + "Policy": { + "target": "com.amazonaws.wafv2#PolicyString", + "traits": { + "smithy.api#documentation": "The IAM policy that is attached to the specified rule group.
" + } + } + } }, - "com.amazonaws.wafv2#DeleteRegexPatternSet": { + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#DeleteRegexPatternSetRequest" + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest" }, "output": { - "target": "com.amazonaws.wafv2#DeleteRegexPatternSetResponse" + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse" }, "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, { "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, @@ -2543,70 +4198,77 @@ }, { "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" } ], "traits": { - "smithy.api#documentation": "Deletes the specified RegexPatternSet.
" + "smithy.api#documentation": "Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum\n number of managed keys that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.
\nFor a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.
\nWAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.
" } }, - "com.amazonaws.wafv2#DeleteRegexPatternSetRequest": { + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "The name of the set. You cannot change the name after you create the set.
", + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the web ACL. You cannot change the name of a web ACL after you create it.
", "smithy.api#required": {} } }, - "Id": { + "WebACLId": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#documentation": "The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", "smithy.api#required": {} } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "RuleGroupRuleName": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The name of the rule group reference statement in your web ACL. This is required only\n when you have the rate-based rule nested inside a rule group.
" + } + }, + "RuleName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the rate-based rule to get the keys for. If you have the rule defined inside\n a rule group that you're using in your web ACL, also provide the name of the rule group\n reference statement in the request parameter RuleGroupRuleName.
The keys that are of Internet Protocol version 4 (IPv4).
" + } + }, + "ManagedKeysIPV6": { + "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", + "traits": { + "smithy.api#documentation": "The keys that are of Internet Protocol version 6 (IPv6).
" + } + } + } }, - "com.amazonaws.wafv2#DeleteRuleGroup": { + "com.amazonaws.wafv2#GetRegexPatternSet": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#DeleteRuleGroupRequest" + "target": "com.amazonaws.wafv2#GetRegexPatternSetRequest" }, "output": { - "target": "com.amazonaws.wafv2#DeleteRuleGroupResponse" + "target": "com.amazonaws.wafv2#GetRegexPatternSetResponse" }, "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, { "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, @@ -2618,28 +4280,19 @@ }, { "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" } ], "traits": { - "smithy.api#documentation": "Deletes the specified RuleGroup.
" + "smithy.api#documentation": "Retrieves the specified RegexPatternSet.
" } }, - "com.amazonaws.wafv2#DeleteRuleGroupRequest": { + "com.amazonaws.wafv2#GetRegexPatternSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
", + "smithy.api#documentation": "The name of the set. You cannot change the name after you create the set.
", "smithy.api#required": {} } }, @@ -2653,35 +4306,38 @@ "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wafv2#GetRegexPatternSetResponse": { + "type": "structure", + "members": { + "RegexPatternSet": { + "target": "com.amazonaws.wafv2#RegexPatternSet", + "traits": { + "smithy.api#documentation": "" } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Deletes the specified WebACL.
\nYou can only use this if ManagedByFirewallManager is false in the specified\n WebACL.
Before deleting any web ACL, first disassociate it from all resources.
\nTo retrieve a list of the resources that are associated with a web ACL, use the\n following calls:
\nFor regional resources, call ListResourcesForWebACL.
\nFor Amazon CloudFront distributions, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId.
To disassociate a resource from a web ACL, use the following calls:
\nFor regional resources, call DisassociateWebACL.
\nFor Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.
Retrieves the specified RuleGroup.
" } }, - "com.amazonaws.wafv2#DeleteWebACLRequest": { + "com.amazonaws.wafv2#GetRuleGroupRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the web ACL. You cannot change the name of a web ACL after you create it.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
" } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" } } } }, - "com.amazonaws.wafv2#DeleteWebACLResponse": { + "com.amazonaws.wafv2#GetRuleGroupResponse": { "type": "structure", - "members": {} + "members": { + "RuleGroup": { + "target": "com.amazonaws.wafv2#RuleGroup", + "traits": { + "smithy.api#documentation": "" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Provides high-level information for a managed rule group, including descriptions of the\n rules.
" + "smithy.api#documentation": "Gets detailed information about a specified number of requests--a sample--that WAF\n randomly selects from among the first 5,000 requests that your Amazon Web Services resource received\n during a time range that you choose. You can specify a sample size of up to 500 requests,\n and you can specify any time range in the previous three hours.
\n\n GetSampledRequests returns a time range, which is usually the time range that\n you specified. However, if your resource (such as a CloudFront distribution) received 5,000\n requests before the specified time range elapsed, GetSampledRequests returns\n an updated time range. This new time range indicates the actual period during which WAF\n selected the requests in the sample.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
", + "smithy.api#documentation": "The Amazon resource name (ARN) of the WebACL for which you want a sample of\n requests.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
", + "smithy.api#documentation": "The metric name assigned to the Rule or RuleGroup for which\n you want a sample of requests.
The version of the rule group. You can only use a version that is not scheduled for\n expiration. If you don't provide this, WAF uses the vendor's default version.
" + "smithy.api#documentation": "The start date and time and the end date and time of the range for which you want\n GetSampledRequests to return a sample of requests. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours. If you specify a start time that's earlier than\n three hours ago, WAF sets it to three hours ago.
The number of requests that you want WAF to return from among the first 5,000\n requests that your Amazon Web Services resource received during the time range. If your resource received\n fewer requests than the value of MaxItems, GetSampledRequests\n returns information about all of them.
The managed rule group's version.
" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.wafv2#ResourceArn", + "SampledRequests": { + "target": "com.amazonaws.wafv2#SampledHTTPRequests", "traits": { - "smithy.api#documentation": "The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.
" + "smithy.api#documentation": "A complex type that contains detailed information about each of the requests in the\n sample.
" } }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", + "PopulationSize": { + "target": "com.amazonaws.wafv2#PopulationSize", "traits": { - "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL\n capacity units (WCU) to calculate and control the operating resources that are used to run\n your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule\n type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so\n users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web\n ACLs is 1,500.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of requests from which GetSampledRequests got a sample of\n MaxItems requests. If PopulationSize is less than\n MaxItems, the sample includes every request that your Amazon Web Services resource\n received during the specified time range.
Usually, TimeWindow is the time range that you specified in the\n GetSampledRequests request. However, if your Amazon Web Services resource received more\n than 5,000 requests during the time range that you specified in the request,\n GetSampledRequests returns the time range for the first 5,000 requests.\n Times are in Coordinated Universal Time (UTC) format.
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.
The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Retrieves the specified WebACL.
" } }, - "com.amazonaws.wafv2#DisassociateWebACL": { + "com.amazonaws.wafv2#GetWebACLForResource": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#DisassociateWebACLRequest" + "target": "com.amazonaws.wafv2#GetWebACLForResourceRequest" }, "output": { - "target": "com.amazonaws.wafv2#DisassociateWebACLResponse" + "target": "com.amazonaws.wafv2#GetWebACLForResourceResponse" }, "errors": [ { @@ -2876,537 +4535,393 @@ }, { "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" } ], "traits": { - "smithy.api#documentation": "Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nFor Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.
Retrieves the WebACL for the specified resource.
" } }, - "com.amazonaws.wafv2#DisassociateWebACLRequest": { + "com.amazonaws.wafv2#GetWebACLForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The web ACL that is associated with the resource. If there is no associated resource,\n WAF returns a null web ACL.
" + } + } } }, - "com.amazonaws.wafv2#EntityId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 + "com.amazonaws.wafv2#GetWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "The name of the web ACL. You cannot change the name of a web ACL after you create it.
", + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#required": {} + } + } } }, - "com.amazonaws.wafv2#EntityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 + "com.amazonaws.wafv2#GetWebACLResponse": { + "type": "structure", + "members": { + "WebACL": { + "target": "com.amazonaws.wafv2#WebACL", + "traits": { + "smithy.api#documentation": "The web ACL specification. You can modify the settings in this web ACL and use it to\n update this web ACL or create a new one.
" + } }, - "smithy.api#pattern": "^[\\w\\-]+$" + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.
The name of the rule whose action you want to override to Count.
The name of the HTTP header.
" + } + }, + "Value": { + "target": "com.amazonaws.wafv2#HeaderValue", + "traits": { + "smithy.api#documentation": "The value of the HTTP header.
" } } }, "traits": { - "smithy.api#documentation": "Specifies a single rule in a rule group whose action you want to override to\n Count. When you exclude a rule, WAF evaluates it exactly as it would if\n the rule action setting were Count. This is a useful option for testing the\n rules in a rule group without modifying how they handle your web traffic.
Part of the response from GetSampledRequests. This is a complex type\n that appears as Headers in the response syntax. HTTPHeader\n contains the names and values of all of the headers that appear in one of the web requests.\n
Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.
Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n
Alternately, you can filter and inspect all headers with the Headers\n FieldToMatch setting.
Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.
\nExample JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n
Inspect all query arguments.
" - } - }, - "UriPath": { - "target": "com.amazonaws.wafv2#UriPath", + "ClientIP": { + "target": "com.amazonaws.wafv2#IPString", "traits": { - "smithy.api#documentation": "Inspect the request URI path. This is the part of the web request that identifies a\n resource, for example, /images/daily-ad.jpg.
The IP address that the request originated from. If the web ACL is associated with a\n CloudFront distribution, this is the value of one of the following fields in CloudFront access\n logs:
\n\n c-ip, if the viewer did not use an HTTP proxy or a load balancer to send\n the request
\n x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer\n to send the request
Inspect the query string. This is the part of a URL that appears after a ?\n character, if any.
The two-letter country code for the country that the request originated from. For a\n current list of country codes, see the Wikipedia entry ISO 3166-1\n alpha-2.
" } }, - "Body": { - "target": "com.amazonaws.wafv2#Body", + "URI": { + "target": "com.amazonaws.wafv2#URIString", "traits": { - "smithy.api#documentation": "Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nOnly the first 8 KB (8192 bytes) of the request body are forwarded to WAF for\n inspection by the underlying host service. For information about how to handle oversized\n request bodies, see the Body object configuration.
The URI path of the request, which identifies the resource, for example,\n /images/daily-ad.jpg.
Inspect the HTTP method. The method indicates the type of operation that the request is\n asking the origin to perform.
" + "smithy.api#documentation": "The HTTP method specified in the sampled web request.
" } }, - "JsonBody": { - "target": "com.amazonaws.wafv2#JsonBody", + "HTTPVersion": { + "target": "com.amazonaws.wafv2#HTTPVersion", "traits": { - "smithy.api#documentation": "Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nOnly the first 8 KB (8192 bytes) of the request body are forwarded to WAF for\n inspection by the underlying host service. For information about how to handle oversized\n request bodies, see the JsonBody object configuration.
The HTTP version specified in the sampled web request, for example,\n HTTP/1.1.
Inspect the request headers. You must configure scope and pattern matching filters in\n the Headers object, to define the set of headers to and the parts of the\n headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize header content in the Headers object.\n WAF applies the pattern matching filters to the headers that it receives from the\n underlying host service.
Inspect the request cookies. You must configure scope and pattern matching filters in\n the Cookies object, to define the set of cookies and the parts of the cookies\n that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize cookie content in the Cookies object.\n WAF applies the pattern matching filters to the cookies that it receives from the\n underlying host service.
A complex type that contains the name and value for each header in the sampled web\n request.
" } } }, "traits": { - "smithy.api#documentation": "The part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.
Example JSON for a QueryString field to match:
\n \"FieldToMatch\": { \"QueryString\": {} }\n
Example JSON for a Method field to match specification:
\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n
Part of the response from GetSampledRequests. This is a complex type\n that appears as Request in the response syntax. HTTPRequest\n contains information about one of the web requests.
How to handle logs that satisfy the filter's conditions and requirement.
", - "smithy.api#required": {} + "smithy.api#documentation": "Inspect all headers.
" } }, - "Requirement": { - "target": "com.amazonaws.wafv2#FilterRequirement", + "IncludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", "traits": { - "smithy.api#documentation": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy\n the filter, a log must match all conditions or must match at least one condition.
", - "smithy.api#required": {} + "smithy.api#documentation": "Inspect only the headers that have a key that matches one of the strings specified here.\n
" } }, - "Conditions": { - "target": "com.amazonaws.wafv2#Conditions", + "ExcludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", "traits": { - "smithy.api#documentation": "Match conditions for the filter.
", - "smithy.api#required": {} + "smithy.api#documentation": "Inspect only the headers whose keys don't match any of the strings specified here.\n
" } } }, "traits": { - "smithy.api#documentation": "A single logging filter, used in LoggingFilter.
" - } - }, - "com.amazonaws.wafv2#FilterBehavior": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "KEEP", - "name": "KEEP" - }, - { - "value": "DROP", - "name": "DROP" - } - ] + "smithy.api#documentation": "The filter to use to identify the subset of headers to inspect in a web request.
\nYou must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n
The name of the rule group. You cannot change the name of a rule group after you create it.
", - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.wafv2#RulePriority", - "traits": { - "smithy.api#documentation": "If you define more than one rule group in the first or last Firewall Manager rule groups, WAF\n evaluates each request against the rule groups in order, starting from the lowest priority\n setting. The priorities don't need to be consecutive, but they must all be\n different.
", - "smithy.api#required": {} - } - }, - "FirewallManagerStatement": { - "target": "com.amazonaws.wafv2#FirewallManagerStatement", + "MatchPattern": { + "target": "com.amazonaws.wafv2#HeaderMatchPattern", "traits": { - "smithy.api#documentation": "The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
", + "smithy.api#documentation": "The filter to use to identify the subset of headers to inspect in a web request.
\nYou must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
\nYou can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.
\nThe parts of the headers to match with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
", + "smithy.api#documentation": "What WAF should do if the headers of the request are larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.
\nThe options for oversize handling are the following:
\n\n CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
A rule group that's defined for an Firewall Manager WAF policy.
" + "smithy.api#documentation": "Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nIf you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.
Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
\nYou cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
" } }, - "com.amazonaws.wafv2#ForwardedIPConfig": { + "com.amazonaws.wafv2#IPAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#IPAddress" + } + }, + "com.amazonaws.wafv2#IPSet": { "type": "structure", "members": { - "HeaderName": { - "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe name of the IP set. You cannot change the name of an IPSet after you create it.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.
\nWAF only evaluates the first IP address found in the specified HTTP header.\n
" - } - }, - "com.amazonaws.wafv2#ForwardedIPHeaderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.wafv2#ForwardedIPPosition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FIRST", - "name": "FIRST" - }, - { - "value": "LAST", - "name": "LAST" - }, - { - "value": "ANY", - "name": "ANY" + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity.
", + "smithy.api#required": {} } - ] - } - }, - "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the IP set that helps with identification.
" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "The version of the IP addresses, either IPV4 or IPV6.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Generates a presigned download URL for the specified release of the mobile SDK.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" + "smithy.api#documentation": "Contains zero or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.
\nWAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
The device platform.
", + "smithy.api#documentation": "The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe release version. For the latest available version, specify\n LATEST.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
The presigned download URL for the specified SDK release.
" + "smithy.api#documentation": "The position in the header to search for the IP address. The header can contain IP\n addresses of the original client and also of proxies. For example, the header value could\n be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the\n original client and the rest identify proxies that the request went through.
The options for this setting are the following:
\nFIRST - Inspect the first IP address in the list of IP addresses in the\n header. This is usually the client's original IP.
\nLAST - Inspect the last IP address in the list of IP addresses in the\n header.
\nANY - Inspect all IP addresses in the header for a match. If the header\n contains more than 10 IP addresses, WAF inspects the last 10.
\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
" } }, - "com.amazonaws.wafv2#GeoMatchStatement": { + "com.amazonaws.wafv2#IPSetReferenceStatement": { "type": "structure", "members": { - "CountryCodes": { - "target": "com.amazonaws.wafv2#CountryCodes", + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "An array of two-character country codes, for example, [ \"US\", \"CN\" ], from\n the alpha-2 country ISO codes of the ISO 3166 international standard.
The Amazon Resource Name (ARN) of the IPSet that this statement\n references.
", + "smithy.api#required": {} } }, - "ForwardedIPConfig": { - "target": "com.amazonaws.wafv2#ForwardedIPConfig", + "IPSetForwardedIPConfig": { + "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", "traits": { "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nA rule statement used to identify web requests based on country of origin.
" + "smithy.api#documentation": "A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" } }, - "com.amazonaws.wafv2#GetIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetIPSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the specified IPSet.
" + "com.amazonaws.wafv2#IPSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#IPSetSummary" } }, - "com.amazonaws.wafv2#GetIPSetRequest": { + "com.amazonaws.wafv2#IPSetSummary": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the IP set. You cannot change the name of an IPSet after you create it.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" } - } - } - }, - "com.amazonaws.wafv2#GetIPSetResponse": { - "type": "structure", - "members": { - "IPSet": { - "target": "com.amazonaws.wafv2#IPSet", + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "A description of the IP set that helps with identification.
" } }, "LockToken": { @@ -3414,318 +4929,256 @@ "traits": { "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Returns the LoggingConfiguration for the specified web ACL.
" - } - }, - "com.amazonaws.wafv2#GetLoggingConfigurationRequest": { - "type": "structure", - "members": { - "ResourceArn": { + "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity.
" } } + }, + "traits": { + "smithy.api#documentation": "High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
The LoggingConfiguration for the specified web ACL.
" + "smithy.api#documentation": "The amount of time, in seconds, that a CAPTCHA token is valid. The default\n setting is 300.
Retrieves the specified managed rule set.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Determines how long a CAPTCHA token remains valid after the client\n successfully solves a CAPTCHA puzzle.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", + "smithy.api#documentation": "The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria.
", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "MatchScope": { + "target": "com.amazonaws.wafv2#JsonMatchScope", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe parts of the JSON to match against using the MatchPattern. If you\n specify All, WAF matches against keys and values.
A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
What WAF should do if it fails to completely parse the JSON body. The options are\n the following:
\n\n EVALUATE_AS_STRING - Inspect the body as plain text. WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.
\n MATCH - Treat the web request as matching the rule statement.\n WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.
\nWAF does its best to parse the entire JSON body, but might be forced to stop for\n reasons such as invalid characters, duplicate keys, truncation, and any content whose root\n node isn't an object or an array.
\nWAF parses the JSON in the following examples as two valid key, value pairs:
\nMissing comma: {\"key1\":\"value1\"\"key2\":\"value2\"}\n
Missing colon: {\"key1\":\"value1\",\"key2\"\"value2\"}\n
Extra colons: {\"key1\"::\"value1\",\"key2\"\"value2\"}\n
What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the body of a web request\n when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to\n WAF by the underlying host service.
\nThe options for oversize handling are the following:
\n\n CONTINUE - Inspect the body normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.
Default: CONTINUE\n
Inspect the body of the web request as JSON. The body immediately follows the request\n headers.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nUse the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n
\nExample JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n
The managed rule set that you requested.
" + "smithy.api#documentation": "Match all of the elements. See also\n MatchScope\n in JsonBody.
You must specify either this setting or the IncludedPaths setting, but not\n both.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Match only the specified include paths. See also\n MatchScope\n in JsonBody.
Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\":\n [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the\n Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON)\n Pointer.
You must specify either this setting or the All setting, but not\n both.
Don't use this option to include all paths. Instead, use the All\n setting.
Retrieves information for the specified mobile SDK release, including release notes and\n tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" + "smithy.api#documentation": "The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.
The device platform.
", - "smithy.api#required": {} + "smithy.api#enumValue": "ALL" } }, - "ReleaseVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", + "KEY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The release version. For the latest available version, specify\n LATEST.
Information for a specified SDK release, including release notes and tags.
" + "smithy.api#enumValue": "VALUE" } } } }, - "com.amazonaws.wafv2#GetPermissionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetPermissionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetPermissionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "com.amazonaws.wafv2#JsonPointerPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], + "smithy.api#pattern": "^([/])|([/](([^~])|(~[01]))+)$" + } + }, + "com.amazonaws.wafv2#JsonPointerPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#JsonPointerPath" + }, "traits": { - "smithy.api#documentation": "Returns the IAM policy that is attached to the specified rule group.
\nYou must be the owner of the rule group to perform this operation.
" + "smithy.api#length": { + "min": 1 + } } }, - "com.amazonaws.wafv2#GetPermissionPolicyRequest": { + "com.amazonaws.wafv2#Label": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", + "Name": { + "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule group for which you want to get the\n policy.
", + "smithy.api#documentation": "The label string.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "A single label container. This is used as an element of a label array in multiple\n contexts, for example, in RuleLabels inside a Rule and in\n Labels inside a SampledHTTPRequest.
The IAM policy that is attached to the specified rule group.
" + "smithy.api#enumValue": "LABEL" } - } - } - }, - "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } } - ], - "traits": { - "smithy.api#documentation": "Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum\n number of managed keys that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.
\nFor a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.
\nWAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.
" } }, - "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { + "com.amazonaws.wafv2#LabelMatchStatement": { "type": "structure", "members": { "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the web ACL. You cannot change the name of a web ACL after you create it.
", + "smithy.api#documentation": "Specify whether you want to match using the label name or just the namespace.
", "smithy.api#required": {} } }, - "WebACLId": { - "target": "com.amazonaws.wafv2#EntityId", + "Key": { + "target": "com.amazonaws.wafv2#LabelMatchKey", "traits": { - "smithy.api#documentation": "The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#documentation": "The string to match against. The setting you provide for this depends on the match\n statement's Scope setting:
If the Scope indicates LABEL, then this specification\n must include the name and can include any number of preceding namespace\n specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this\n specification can include any number of contiguous namespace strings, and can include\n the entire label namespace prefix from the rule group or web ACL where the label\n originates.
Labels are case sensitive and components of a label must be separated by colon, for\n example NS1:NS2:name.
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
\nThe label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
" + } + }, + "com.amazonaws.wafv2#LabelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 }, - "RuleGroupRuleName": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "The name of the rule group reference statement in your web ACL. This is required only\n when you have the rate-based rule nested inside a rule group.
" - } - }, - "RuleName": { - "target": "com.amazonaws.wafv2#EntityName", + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" + } + }, + "com.amazonaws.wafv2#LabelNameCondition": { + "type": "structure", + "members": { + "LabelName": { + "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The name of the rate-based rule to get the keys for. If you have the rule defined inside\n a rule group that you're using in your web ACL, also provide the name of the rule group\n reference statement in the request parameter RuleGroupRuleName.
The label name that a log record must contain in order to meet the condition. This must\n be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "A single label name condition for a Condition in a logging\n filter.
" } }, - "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse": { + "com.amazonaws.wafv2#LabelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#LabelSummary" + } + }, + "com.amazonaws.wafv2#LabelSummary": { "type": "structure", "members": { - "ManagedKeysIPV4": { - "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", - "traits": { - "smithy.api#documentation": "The keys that are of Internet Protocol version 4 (IPv4).
" - } - }, - "ManagedKeysIPV6": { - "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", + "Name": { + "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "The keys that are of Internet Protocol version 6 (IPv6).
" + "smithy.api#documentation": "An individual label specification.
" } } + }, + "traits": { + "smithy.api#documentation": "List of labels used by one or more of the rules of a RuleGroup. This\n summary object is used for the following rule group lists:
\n\n AvailableLabels - Labels that rules add to matching requests.\n These labels are defined in the RuleLabels for a Rule.
\n ConsumedLabels - Labels that rules match against.\n These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Retrieves the specified RegexPatternSet.
" + "smithy.api#documentation": "Returns a list of the available versions for the specified managed rule group.
" } }, - "com.amazonaws.wafv2#GetRegexPatternSetRequest": { + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest": { "type": "structure", "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "The name of the set. You cannot change the name after you create the set.
", + "smithy.api#documentation": "The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
", "smithy.api#required": {} } }, @@ -3762,39 +5222,50 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The versions that are currently available for the specified managed rule group.
" + } + }, + "CurrentDefaultVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "The name of the version that's currently set as the default.
" } } } }, - "com.amazonaws.wafv2#GetRuleGroup": { + "com.amazonaws.wafv2#ListAvailableManagedRuleGroups": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#GetRuleGroupRequest" + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest" }, "output": { - "target": "com.amazonaws.wafv2#GetRuleGroupResponse" + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse" }, "errors": [ { @@ -3805,101 +5276,79 @@ }, { "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" } ], "traits": { - "smithy.api#documentation": "Retrieves the specified RuleGroup.
" + "smithy.api#documentation": "Retrieves an array of managed rule groups that are available for you to use. This list\n includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're\n subscribed to.
" } }, - "com.amazonaws.wafv2#GetRuleGroupRequest": { + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "The name of the rule group. You cannot change the name of a rule group after you create it.
" - } - }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The Amazon Resource Name (ARN) of the entity.
" + "smithy.api#documentation": "The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Gets detailed information about a specified number of requests--a sample--that WAF\n randomly selects from among the first 5,000 requests that your Amazon Web Services resource received\n during a time range that you choose. You can specify a sample size of up to 500 requests,\n and you can specify any time range in the previous three hours.
\n\n GetSampledRequests returns a time range, which is usually the time range that\n you specified. However, if your resource (such as a CloudFront distribution) received 5,000\n requests before the specified time range elapsed, GetSampledRequests returns\n an updated time range. This new time range indicates the actual period during which WAF\n selected the requests in the sample.
Retrieves an array of IPSetSummary objects for the IP sets that you\n manage.
" } }, - "com.amazonaws.wafv2#GetSampledRequestsRequest": { + "com.amazonaws.wafv2#ListIPSetsRequest": { "type": "structure", "members": { - "WebAclArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon resource name (ARN) of the WebACL for which you want a sample of\n requests.
The metric name assigned to the Rule or RuleGroup for which\n you want a sample of requests.
The start date and time and the end date and time of the range for which you want\n GetSampledRequests to return a sample of requests. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours. If you specify a start time that's earlier than\n three hours ago, WAF sets it to three hours ago.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The number of requests that you want WAF to return from among the first 5,000\n requests that your Amazon Web Services resource received during the time range. If your resource received\n fewer requests than the value of MaxItems, GetSampledRequests\n returns information about all of them.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
A complex type that contains detailed information about each of the requests in the\n sample.
" - } - }, - "PopulationSize": { - "target": "com.amazonaws.wafv2#PopulationSize", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "The total number of requests from which GetSampledRequests got a sample of\n MaxItems requests. If PopulationSize is less than\n MaxItems, the sample includes every request that your Amazon Web Services resource\n received during the specified time range.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Usually, TimeWindow is the time range that you specified in the\n GetSampledRequests request. However, if your Amazon Web Services resource received more\n than 5,000 requests during the time range that you specified in the request,\n GetSampledRequests returns the time range for the first 5,000 requests.\n Times are in Coordinated Universal Time (UTC) format.
Array of IPSets. This may not be the full list of IPSets that you have defined. See the\n Limit specification for this request.
Retrieves the specified WebACL.
" - } - }, - "com.amazonaws.wafv2#GetWebACLForResource": { + "com.amazonaws.wafv2#ListLoggingConfigurations": { "type": "operation", "input": { - "target": "com.amazonaws.wafv2#GetWebACLForResourceRequest" + "target": "com.amazonaws.wafv2#ListLoggingConfigurationsRequest" }, "output": { - "target": "com.amazonaws.wafv2#GetWebACLForResourceResponse" + "target": "com.amazonaws.wafv2#ListLoggingConfigurationsResponse" }, "errors": [ { @@ -3989,2200 +5404,1471 @@ }, { "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" } ], "traits": { - "smithy.api#documentation": "Retrieves the WebACL for the specified resource.
" - } - }, - "com.amazonaws.wafv2#GetWebACLForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
\n \nThe ARN must be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n
The web ACL that is associated with the resource. If there is no associated resource,\n WAF returns a null web ACL.
" - } - } - } - }, - "com.amazonaws.wafv2#GetWebACLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "The name of the web ACL. You cannot change the name of a web ACL after you create it.
", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", - "smithy.api#required": {} - } - } + "smithy.api#documentation": "Retrieves an array of your LoggingConfiguration objects.
" } }, - "com.amazonaws.wafv2#GetWebACLResponse": { + "com.amazonaws.wafv2#ListLoggingConfigurationsRequest": { "type": "structure", "members": { - "WebACL": { - "target": "com.amazonaws.wafv2#WebACL", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "The web ACL specification. You can modify the settings in this web ACL and use it to\n update this web ACL or create a new one.
" + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nA token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The name of the HTTP header.
" + "smithy.api#documentation": "" } }, - "Value": { - "target": "com.amazonaws.wafv2#HeaderValue", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "The value of the HTTP header.
" + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Part of the response from GetSampledRequests. This is a complex type\n that appears as Headers in the response syntax. HTTPHeader\n contains the names and values of all of the headers that appear in one of the web requests.\n
Retrieves the managed rule sets that you own.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The IP address that the request originated from. If the web ACL is associated with a\n CloudFront distribution, this is the value of one of the following fields in CloudFront access\n logs:
\n\n c-ip, if the viewer did not use an HTTP proxy or a load balancer to send\n the request
\n x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer\n to send the request
The two-letter country code for the country that the request originated from. For a\n current list of country codes, see the Wikipedia entry ISO 3166-1\n alpha-2.
" - } - }, - "URI": { - "target": "com.amazonaws.wafv2#URIString", - "traits": { - "smithy.api#documentation": "The URI path of the request, which identifies the resource, for example,\n /images/daily-ad.jpg.
The HTTP method specified in the sampled web request.
" + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe HTTP version specified in the sampled web request, for example,\n HTTP/1.1.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A complex type that contains the name and value for each header in the sampled web\n request.
" + "smithy.api#documentation": "The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
Part of the response from GetSampledRequests. This is a complex type\n that appears as Request in the response syntax. HTTPRequest\n contains information about one of the web requests.
Inspect all headers.
" - } - }, - "IncludedHeaders": { - "target": "com.amazonaws.wafv2#HeaderNames", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "Inspect only the headers that have a key that matches one of the strings specified here.\n
" + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Inspect only the headers whose keys don't match any of the strings specified here.\n
" + "smithy.api#documentation": "Your managed rule sets.
" } } - }, - "traits": { - "smithy.api#documentation": "The filter to use to identify the subset of headers to inspect in a web request.
\nYou must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n
Retrieves a list of the available releases for the mobile SDK and the specified device\n platform.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" + } }, - "com.amazonaws.wafv2#Headers": { + "com.amazonaws.wafv2#ListMobileSdkReleasesRequest": { "type": "structure", "members": { - "MatchPattern": { - "target": "com.amazonaws.wafv2#HeaderMatchPattern", + "Platform": { + "target": "com.amazonaws.wafv2#Platform", "traits": { - "smithy.api#documentation": "The filter to use to identify the subset of headers to inspect in a web request.
\nYou must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n
The device platform to retrieve the list for.
", "smithy.api#required": {} } }, - "MatchScope": { - "target": "com.amazonaws.wafv2#MapMatchScope", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "The parts of the headers to match with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
What WAF should do if the headers of the request are larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.
\nThe options for oversize handling are the following:
\n\n CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nIf you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.
Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n
The name of the IP set. You cannot change the name of an IPSet after you create it.
High level information for the available SDK releases.
" } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Retrieves an array of RegexPatternSetSummary objects for the regex\n pattern sets that you manage.
" + } + }, + "com.amazonaws.wafv2#ListRegexPatternSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
", + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe Amazon Resource Name (ARN) of the entity.
", - "smithy.api#required": {} + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A description of the IP set that helps with identification.
" + "smithy.api#documentation": "The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The version of the IP addresses, either IPV4 or IPV6.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExample address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains zero or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.
\nWAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that\n are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use\n the CloudFront call ListDistributionsByWebACLId.
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThe Amazon Resource Name (ARN) of the web ACL.
", "smithy.api#required": {} } }, - "FallbackBehavior": { - "target": "com.amazonaws.wafv2#FallbackBehavior", + "ResourceType": { + "target": "com.amazonaws.wafv2#ResourceType", "traits": { - "smithy.api#documentation": "The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
Used for web ACLs that are scoped for regional applications.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nIf you don't provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.
Default: APPLICATION_LOAD_BALANCER\n
The position in the header to search for the IP address. The header can contain IP\n addresses of the original client and also of proxies. For example, the header value could\n be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the\n original client and the rest identify proxies that the request went through.
The options for this setting are the following:
\nFIRST - Inspect the first IP address in the list of IP addresses in the\n header. This is usually the client's original IP.
\nLAST - Inspect the last IP address in the list of IP addresses in the\n header.
\nANY - Inspect all IP addresses in the header for a match. If the header\n contains more than 10 IP addresses, WAF inspects the last 10.
\nThe array of Amazon Resource Names (ARNs) of the associated resources.
" } } + } + }, + "com.amazonaws.wafv2#ListRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListRuleGroupsResponse" }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], "traits": { - "smithy.api#documentation": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nThis configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
" + "smithy.api#documentation": "Retrieves an array of RuleGroupSummary objects for the rule groups\n that you manage.
" } }, - "com.amazonaws.wafv2#IPSetReferenceStatement": { + "com.amazonaws.wafv2#ListRuleGroupsRequest": { "type": "structure", "members": { - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IPSet that this statement\n references.
", + "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
\n \nIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
\nWhen you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
" - } - }, - "com.amazonaws.wafv2#IPSetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#IPSetSummary" } }, - "com.amazonaws.wafv2#IPSetSummary": { + "com.amazonaws.wafv2#ListRuleGroupsResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "The name of the IP set. You cannot change the name of an IPSet after you create it.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + "smithy.api#documentation": "" } + } + } + }, + "com.amazonaws.wafv2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the TagInfoForResource for the specified resource. Tags are\n key:value pairs that you can use to categorize and manage your resources, for purposes like\n billing. For example, you might set the tag key to \"customer\" and the value to the customer\n name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags\n for a resource.
\nYou can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.
" + } + }, + "com.amazonaws.wafv2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "A description of the IP set that helps with identification.
" + "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The Amazon Resource Name (ARN) of the entity.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
The amount of time, in seconds, that a CAPTCHA token is valid. The default\n setting is 300.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The collection of tagging definitions for the resource.
" } } - }, + } + }, + "com.amazonaws.wafv2#ListWebACLs": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListWebACLsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListWebACLsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], "traits": { - "smithy.api#documentation": "Determines how long a CAPTCHA token remains valid after the client\n successfully solves a CAPTCHA puzzle.
Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.
" } }, - "com.amazonaws.wafv2#JsonBody": { + "com.amazonaws.wafv2#ListWebACLsRequest": { "type": "structure", "members": { - "MatchPattern": { - "target": "com.amazonaws.wafv2#JsonMatchPattern", - "traits": { - "smithy.api#documentation": "The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria.
", - "smithy.api#required": {} - } - }, - "MatchScope": { - "target": "com.amazonaws.wafv2#JsonMatchScope", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "The parts of the JSON to match against using the MatchPattern. If you\n specify All, WAF matches against keys and values.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nWhat WAF should do if it fails to completely parse the JSON body. The options are\n the following:
\n\n EVALUATE_AS_STRING - Inspect the body as plain text. WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.
\n MATCH - Treat the web request as matching the rule statement.\n WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.
\nWAF does its best to parse the entire JSON body, but might be forced to stop for\n reasons such as invalid characters, duplicate keys, truncation, and any content whose root\n node isn't an object or an array.
\nWAF parses the JSON in the following examples as two valid key, value pairs:
\nMissing comma: {\"key1\":\"value1\"\"key2\":\"value2\"}\n
Missing colon: {\"key1\":\"value1\",\"key2\"\"value2\"}\n
Extra colons: {\"key1\"::\"value1\",\"key2\"\"value2\"}\n
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the body of a web request\n when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to\n WAF by the underlying host service.
\nThe options for oversize handling are the following:
\n\n CONTINUE - Inspect the body normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.
Default: CONTINUE\n
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
Inspect the body of the web request as JSON. The body immediately follows the request\n headers.
\nThis is used to indicate the web request component to inspect, in the FieldToMatch specification.
\nUse the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n
\nExample JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n
Match all of the elements. See also\n MatchScope\n in JsonBody.
You must specify either this setting or the IncludedPaths setting, but not\n both.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Match only the specified include paths. See also\n MatchScope\n in JsonBody.
Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\":\n [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the\n Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON)\n Pointer.
You must specify either this setting or the All setting, but not\n both.
Don't use this option to include all paths. Instead, use the All\n setting.
The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.
The label string.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.
A single label container. This is used as an element of a label array in multiple\n contexts, for example, in RuleLabels inside a Rule and in\n Labels inside a SampledHTTPRequest.
Specify whether you want to match using the label name or just the namespace.
", + "smithy.api#documentation": "The logging destination configuration that you want to associate with the web\n ACL.
\nYou can associate one logging destination to a web ACL.
\nThe string to match against. The setting you provide for this depends on the match\n statement's Scope setting:
If the Scope indicates LABEL, then this specification\n must include the name and can include any number of preceding namespace\n specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this\n specification can include any number of contiguous namespace strings, and can include\n the entire label namespace prefix from the rule group or web ACL where the label\n originates.
Labels are case sensitive and components of a label must be separated by colon, for\n example NS1:NS2:name.
The parts of the request that you want to keep out of the logs. For example, if you\n redact the SingleHeader field, the HEADER field in the logs will\n be xxx.
You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, Method, and\n JsonBody.
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
\nThe label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
" - } - }, - "com.amazonaws.wafv2#LabelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" - } - }, - "com.amazonaws.wafv2#LabelNameCondition": { - "type": "structure", - "members": { - "LabelName": { - "target": "com.amazonaws.wafv2#LabelName", + "ManagedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "The label name that a log record must contain in order to meet the condition. This must\n be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
", - "smithy.api#required": {} + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.
" + } + }, + "LoggingFilter": { + "target": "com.amazonaws.wafv2#LoggingFilter", + "traits": { + "smithy.api#documentation": "Filtering that specifies which web requests are kept in the logs and which are dropped.\n You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.
" } } }, "traits": { - "smithy.api#documentation": "A single label name condition for a Condition in a logging\n filter.
" + "smithy.api#documentation": "Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
" } }, - "com.amazonaws.wafv2#LabelSummaries": { + "com.amazonaws.wafv2#LoggingConfigurations": { "type": "list", "member": { - "target": "com.amazonaws.wafv2#LabelSummary" + "target": "com.amazonaws.wafv2#LoggingConfiguration" } }, - "com.amazonaws.wafv2#LabelSummary": { + "com.amazonaws.wafv2#LoggingFilter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#LabelName", + "Filters": { + "target": "com.amazonaws.wafv2#Filters", "traits": { - "smithy.api#documentation": "An individual label specification.
" + "smithy.api#documentation": "The filters that you want to apply to the logs.
", + "smithy.api#required": {} + } + }, + "DefaultBehavior": { + "target": "com.amazonaws.wafv2#FilterBehavior", + "traits": { + "smithy.api#documentation": "Default handling for logs that don't match any of the specified filtering conditions.\n
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "List of labels used by one or more of the rules of a RuleGroup. This\n summary object is used for the following rule group lists:
\n\n AvailableLabels - Labels that rules add to matching requests.\n These labels are defined in the RuleLabels for a Rule.
\n ConsumedLabels - Labels that rules match against.\n These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Filtering that specifies which web requests are kept in the logs and which are dropped,\n defined for a web ACL's LoggingConfiguration.
\nYou can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.
" } }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], + "com.amazonaws.wafv2#LoginPathString": { + "type": "string", "traits": { - "smithy.api#documentation": "Returns a list of the available versions for the specified managed rule group.
" + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" } }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest": { + "com.amazonaws.wafv2#ManagedRuleGroupConfig": { "type": "structure", "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nWhen you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The payload type for your login endpoint, either JSON or form encoded.
" } }, - "Versions": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupVersions", + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", "traits": { - "smithy.api#documentation": "The versions that are currently available for the specified managed rule group.
" + "smithy.api#documentation": "Details about your login page username field.
" } }, - "CurrentDefaultVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", "traits": { - "smithy.api#documentation": "The name of the version that's currently set as the default.
" + "smithy.api#documentation": "Details about your login page password field.
" } } + }, + "traits": { + "smithy.api#documentation": "Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
For example specifications, see the examples section of CreateWebACL.
" } }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse" + "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupConfig" }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], "traits": { - "smithy.api#documentation": "Retrieves an array of managed rule groups that are available for you to use. This list\n includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're\n subscribed to.
" + "smithy.api#length": { + "min": 1 + } } }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { + "com.amazonaws.wafv2#ManagedRuleGroupStatement": { "type": "structure", "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
", "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
", + "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", + "Version": { + "target": "com.amazonaws.wafv2#VersionKeyString", "traits": { - "smithy.api#documentation": "The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The version of the managed rule group to use. If you specify this, the version setting\n is fixed until you change it. If you don't specify this, WAF uses the vendor's\n default version, and then keeps the version at the vendor's default when the vendor updates\n the managed rule group settings.
" } - } - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + }, + "ExcludedRules": { + "target": "com.amazonaws.wafv2#ExcludedRules", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The rules in the referenced rule group whose actions are set to Count. When\n you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were\n Count. This is a useful option for testing the rules in a rule group\n without modifying how they handle your web traffic.
An optional nested statement that narrows the scope of the web requests that are\n evaluated by the managed rule group. Requests are only evaluated by the rule group if they\n match the scope-down statement. You can use any nestable Statement in the\n scope-down statement, and you can nest statements at any level, the same as you can for a\n rule statement.
" } - } - } - }, - "com.amazonaws.wafv2#ListIPSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListIPSetsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListIPSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "ManagedRuleGroupConfigs": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupConfigs", + "traits": { + "smithy.api#documentation": "Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
Retrieves an array of IPSetSummary objects for the IP sets that you\n manage.
" + "smithy.api#documentation": "A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
" } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" } }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", + "VersioningSupported": { + "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
Indicates whether the managed rule group is versioned. If it is, you can retrieve the\n versions list by calling ListAvailableManagedRuleGroupVersions.
" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
" } } + }, + "traits": { + "smithy.api#documentation": "High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Amazon Web Services Marketplace managed rule groups, which you can subscribe to through Amazon Web Services Marketplace.
" } }, - "com.amazonaws.wafv2#ListIPSetsResponse": { + "com.amazonaws.wafv2#ManagedRuleGroupVersion": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Name": { + "target": "com.amazonaws.wafv2#VersionKeyString", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The version name.
" } }, - "IPSets": { - "target": "com.amazonaws.wafv2#IPSetSummaries", + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "Array of IPSets. This may not be the full list of IPSets that you have defined. See the\n Limit specification for this request.
The date and time that the managed rule group owner updated the rule group version\n information.
" } } - } - }, - "com.amazonaws.wafv2#ListLoggingConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListLoggingConfigurationsRequest" }, - "output": { - "target": "com.amazonaws.wafv2#ListLoggingConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], "traits": { - "smithy.api#documentation": "Retrieves an array of your LoggingConfiguration objects.
" + "smithy.api#documentation": "Describes a single version of a managed rule group.
" } }, - "com.amazonaws.wafv2#ListLoggingConfigurationsRequest": { + "com.amazonaws.wafv2#ManagedRuleGroupVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersion" + } + }, + "com.amazonaws.wafv2#ManagedRuleSet": { "type": "structure", "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The Amazon Resource Name (ARN) of the entity.
", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.wafv2#ListLoggingConfigurationsResponse": { - "type": "structure", - "members": { - "LoggingConfigurations": { - "target": "com.amazonaws.wafv2#LoggingConfigurations", + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "A description of the set that helps with identification.
" } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "PublishedVersions": { + "target": "com.amazonaws.wafv2#PublishedVersions", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The versions of this managed rule set that are available for use by customers.
" } - } - } - }, - "com.amazonaws.wafv2#ListManagedRuleSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListManagedRuleSetsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListManagedRuleSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "The version that you would like your customers to use.
" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
Retrieves the managed rule sets that you own.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed\n rule groups for customers of WAF.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nThe name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
" } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
A description of the set that helps with identification.
" } - } - } - }, - "com.amazonaws.wafv2#ListManagedRuleSetsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Your managed rule sets.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity.
" } - } - } - }, - "com.amazonaws.wafv2#ListMaxItems": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.wafv2#ListMobileSdkReleases": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListMobileSdkReleasesRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListMobileSdkReleasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
Retrieves a list of the available releases for the mobile SDK and the specified device\n platform.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" + "smithy.api#documentation": "High-level information for a managed rule set.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The device platform to retrieve the list for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vendor rule group that's used to define the\n published version of your managed rule group.
" } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The web ACL capacity units (WCUs) required for this rule group.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
" } }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", "traits": { - "smithy.api#documentation": "The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The amount of time you expect this version of your managed rule group to last, in days.\n
" } - } - } - }, - "com.amazonaws.wafv2#ListMobileSdkReleasesResponse": { - "type": "structure", - "members": { - "ReleaseSummaries": { - "target": "com.amazonaws.wafv2#ReleaseSummaries", + }, + "PublishTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "High level information for the available SDK releases.
" + "smithy.api#documentation": "The time that you first published this version.
\nTimes are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The last time that you updated this version.
\nTimes are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" } - } - } - }, - "com.amazonaws.wafv2#ListRegexPatternSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListRegexPatternSetsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListRegexPatternSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this version is set to expire.
\nTimes are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Retrieves an array of RegexPatternSetSummary objects for the regex\n pattern sets that you manage.
" + "smithy.api#documentation": "Information for a single version of a managed rule set.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nWhen you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"Method\": {}\n
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The release version.
" } }, - "RegexPatternSets": { - "target": "com.amazonaws.wafv2#RegexPatternSetSummaries", + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The timestamp of the release.
" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.wafv2#ReleaseNotes", + "traits": { + "smithy.api#documentation": "Notes describing the release.
" + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "Tags that are associated with the release.
" } } + }, + "traits": { + "smithy.api#documentation": "Information for a release of the mobile SDK, including release notes and tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" } }, - "com.amazonaws.wafv2#ListResourcesForWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListResourcesForWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListResourcesForWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "com.amazonaws.wafv2#NextMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#NoneAction": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#documentation": "Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that\n are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use\n the CloudFront call ListDistributionsByWebACLId.
Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
\nJSON specification: \"None\": {}\n
The Amazon Resource Name (ARN) of the web ACL.
", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.wafv2#ResourceType", + "members": { + "Statement": { + "target": "com.amazonaws.wafv2#Statement", "traits": { - "smithy.api#documentation": "Used for web ACLs that are scoped for regional applications.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
" + "smithy.api#documentation": "The statement to negate. You can use any statement that can be nested.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
The array of Amazon Resource Names (ARNs) of the associated resources.
" + "smithy.api#documentation": "The statements to combine with OR logic. You can use any statements that can be\n nested.
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.wafv2#ListRuleGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListRuleGroupsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListRuleGroupsResponse" }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], "traits": { - "smithy.api#documentation": "Retrieves an array of RuleGroupSummary objects for the rule groups\n that you manage.
" + "smithy.api#documentation": "A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nWhen you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Override the rule group evaluation result to count only.
\nThis option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.
\nThe maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
Don't override the rule group evaluation result. This is the most common setting.
" } } + }, + "traits": { + "smithy.api#documentation": "The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
\nYou can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.
\nWhen you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Retrieves the TagInfoForResource for the specified resource. Tags are\n key:value pairs that you can use to categorize and manage your resources, for purposes like\n billing. For example, you might set the tag key to \"customer\" and the value to the customer\n name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags\n for a resource.
\nYou can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.
" + "smithy.api#range": { + "min": 1, + "max": 100 + } } }, - "com.amazonaws.wafv2#ListTagsForResourceRequest": { - "type": "structure", + "com.amazonaws.wafv2#ParameterExceptionField": { + "type": "enum", "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "WEB_ACL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} + "smithy.api#enumValue": "REGEX_PATTERN_SET" } - } - } - }, - "com.amazonaws.wafv2#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + }, + "IP_SET": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The collection of tagging definitions for the resource.
" + "smithy.api#enumValue": "MANAGED_RULE_SET" } - } - } - }, - "com.amazonaws.wafv2#ListWebACLs": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListWebACLsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListWebACLsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.
" - } - }, - "com.amazonaws.wafv2#ListWebACLsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "RULE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
\nTo work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
\nCLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
\nWhen you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.
The logging destination configuration that you want to associate with the web\n ACL.
\nYou can associate one logging destination to a web ACL.
\nThe parts of the request that you want to keep out of the logs. For example, if you\n redact the SingleHeader field, the HEADER field in the logs will\n be xxx.
You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, Method, and\n JsonBody.
Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.
" + "smithy.api#enumValue": "RATE_BASED_STATEMENT" } }, - "LoggingFilter": { - "target": "com.amazonaws.wafv2#LoggingFilter", + "RULE_GROUP_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Filtering that specifies which web requests are kept in the logs and which are dropped.\n You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.
" + "smithy.api#enumValue": "RULE_GROUP_REFERENCE_STATEMENT" } - } - }, - "traits": { - "smithy.api#documentation": "Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
" - } - }, - "com.amazonaws.wafv2#LoggingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#LoggingConfiguration" - } - }, - "com.amazonaws.wafv2#LoggingFilter": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.wafv2#Filters", + }, + "REGEX_PATTERN_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The filters that you want to apply to the logs.
", - "smithy.api#required": {} + "smithy.api#enumValue": "REGEX_PATTERN_REFERENCE_STATEMENT" + } + }, + "IP_SET_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET_REFERENCE_STATEMENT" } }, - "DefaultBehavior": { - "target": "com.amazonaws.wafv2#FilterBehavior", + "MANAGED_RULE_SET_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Default handling for logs that don't match any of the specified filtering conditions.\n
", - "smithy.api#required": {} + "smithy.api#enumValue": "MANAGED_RULE_SET_STATEMENT" } - } - }, - "traits": { - "smithy.api#documentation": "Filtering that specifies which web requests are kept in the logs and which are dropped,\n defined for a web ACL's LoggingConfiguration.
\nYou can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.
" - } - }, - "com.amazonaws.wafv2#LoginPathString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupConfig": { - "type": "structure", - "members": { - "LoginPath": { - "target": "com.amazonaws.wafv2#LoginPathString", + "LABEL_MATCH_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login.
The payload type for your login endpoint, either JSON or form encoded.
" + "smithy.api#enumValue": "AND_STATEMENT" } }, - "UsernameField": { - "target": "com.amazonaws.wafv2#UsernameField", + "OR_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Details about your login page username field.
" + "smithy.api#enumValue": "OR_STATEMENT" } }, - "PasswordField": { - "target": "com.amazonaws.wafv2#PasswordField", + "NOT_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Details about your login page password field.
" + "smithy.api#enumValue": "NOT_STATEMENT" } - } - }, - "traits": { - "smithy.api#documentation": "Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
For example specifications, see the examples section of CreateWebACL.
" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupStatement": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
", - "smithy.api#required": {} + "smithy.api#enumValue": "IP_ADDRESS" } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "IP_ADDRESS_VERSION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
", - "smithy.api#required": {} + "smithy.api#enumValue": "IP_ADDRESS_VERSION" } }, - "Version": { - "target": "com.amazonaws.wafv2#VersionKeyString", + "FIELD_TO_MATCH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the managed rule group to use. If you specify this, the version setting\n is fixed until you change it. If you don't specify this, WAF uses the vendor's\n default version, and then keeps the version at the vendor's default when the vendor updates\n the managed rule group settings.
" + "smithy.api#enumValue": "FIELD_TO_MATCH" } }, - "ExcludedRules": { - "target": "com.amazonaws.wafv2#ExcludedRules", + "TEXT_TRANSFORMATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The rules in the referenced rule group whose actions are set to Count. When\n you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were\n Count. This is a useful option for testing the rules in a rule group\n without modifying how they handle your web traffic.
An optional nested statement that narrows the scope of the web requests that are\n evaluated by the managed rule group. Requests are only evaluated by the rule group if they\n match the scope-down statement. You can use any nestable Statement in the\n scope-down statement, and you can nest statements at any level, the same as you can for a\n rule statement.
" + "smithy.api#enumValue": "SINGLE_QUERY_ARGUMENT" } }, - "ManagedRuleGroupConfigs": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupConfigs", + "SINGLE_HEADER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
" + "smithy.api#enumValue": "DEFAULT_ACTION" } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "RULE_ACTION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" + "smithy.api#enumValue": "RULE_ACTION" } }, - "VersioningSupported": { - "target": "com.amazonaws.wafv2#Boolean", + "ENTITY_LIMIT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Indicates whether the managed rule group is versioned. If it is, you can retrieve the\n versions list by calling ListAvailableManagedRuleGroupVersions.
" + "smithy.api#enumValue": "ENTITY_LIMIT" } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "OVERRIDE_ACTION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
" + "smithy.api#enumValue": "OVERRIDE_ACTION" } - } - }, - "traits": { - "smithy.api#documentation": "High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Amazon Web Services Marketplace managed rule groups, which you can subscribe to through Amazon Web Services Marketplace.
" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupVersion": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#VersionKeyString", + }, + "SCOPE_VALUE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version name.
" + "smithy.api#enumValue": "SCOPE_VALUE" } }, - "LastUpdateTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", + "RESOURCE_ARN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The date and time that the managed rule group owner updated the rule group version\n information.
" + "smithy.api#enumValue": "RESOURCE_ARN" } - } - }, - "traits": { - "smithy.api#documentation": "Describes a single version of a managed rule group.
" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupVersions": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupVersion" - } - }, - "com.amazonaws.wafv2#ManagedRuleSet": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
", - "smithy.api#required": {} + "smithy.api#enumValue": "RESOURCE_TYPE" } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "TAGS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
The Amazon Resource Name (ARN) of the entity.
", - "smithy.api#required": {} + "smithy.api#enumValue": "TAG_KEYS" } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "METRIC_NAME": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A description of the set that helps with identification.
" + "smithy.api#enumValue": "METRIC_NAME" } }, - "PublishedVersions": { - "target": "com.amazonaws.wafv2#PublishedVersions", + "FIREWALL_MANAGER_STATEMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The versions of this managed rule set that are available for use by customers.
" + "smithy.api#enumValue": "FIREWALL_MANAGER_STATEMENT" } }, - "RecommendedVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", + "FALLBACK_BEHAVIOR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version that you would like your customers to use.
" + "smithy.api#enumValue": "FALLBACK_BEHAVIOR" } }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", + "POSITION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed\n rule groups for customers of WAF.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
\nThis name is assigned to the corresponding managed rule group, which your customers can access and use.
" + "smithy.api#enumValue": "FORWARDED_IP_CONFIG" } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "IP_SET_FORWARDED_IP_CONFIG": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
A description of the set that helps with identification.
" + "smithy.api#enumValue": "HEADER_NAME" } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "CUSTOM_REQUEST_HANDLING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" + "smithy.api#enumValue": "RESPONSE_CONTENT_TYPE" } }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", + "CUSTOM_RESPONSE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
\nThe syntax for the label namespace prefix for a managed rule group is the following:
\n\n awswaf:managed::
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
\n\n \n
High-level information for a managed rule set.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The Amazon Resource Name (ARN) of the vendor rule group that's used to define the\n published version of your managed rule group.
" + "smithy.api#enumValue": "CUSTOM_RESPONSE_BODY" } }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", + "JSON_MATCH_PATTERN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
" + "smithy.api#enumValue": "JSON_MATCH_PATTERN" } }, - "ForecastedLifetime": { - "target": "com.amazonaws.wafv2#TimeWindowDay", + "JSON_MATCH_SCOPE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The amount of time you expect this version of your managed rule group to last, in days.\n
" + "smithy.api#enumValue": "JSON_MATCH_SCOPE" } }, - "PublishTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", + "BODY_PARSING_FALLBACK_BEHAVIOR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time that you first published this version.
\nTimes are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + "smithy.api#enumValue": "BODY_PARSING_FALLBACK_BEHAVIOR" } }, - "LastUpdateTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", + "LOGGING_FILTER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The last time that you updated this version.
\nTimes are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + "smithy.api#enumValue": "LOGGING_FILTER" } }, - "ExpiryTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", + "FILTER_CONDITION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time that this version is set to expire.
\nTimes are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + "smithy.api#enumValue": "FILTER_CONDITION" } - } - }, - "traits": { - "smithy.api#documentation": "Information for a single version of a managed rule set.
\nThis is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
\nVendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.
\nThis is used only in the FieldToMatch specification for some web request component types.
\nJSON specification: \"Method\": {}\n
The release version.
" + "smithy.api#enumValue": "CHANGE_PROPAGATION_STATUS" } }, - "Timestamp": { - "target": "com.amazonaws.wafv2#Timestamp", + "ASSOCIABLE_RESOURCE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The timestamp of the release.
" + "smithy.api#enumValue": "ASSOCIABLE_RESOURCE" } }, - "ReleaseNotes": { - "target": "com.amazonaws.wafv2#ReleaseNotes", + "LOG_DESTINATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Notes describing the release.
" + "smithy.api#enumValue": "LOG_DESTINATION" } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", + "MANAGED_RULE_GROUP_CONFIG": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Tags that are associated with the release.
" + "smithy.api#enumValue": "MANAGED_RULE_GROUP_CONFIG" } - } - }, - "traits": { - "smithy.api#documentation": "Information for a release of the mobile SDK, including release notes and tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" - } - }, - "com.amazonaws.wafv2#NextMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#NoneAction": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
\nJSON specification: \"None\": {}\n
The statement to negate. You can use any statement that can be nested.
", - "smithy.api#required": {} + "smithy.api#enumValue": "PAYLOAD_TYPE" } - } - }, - "traits": { - "smithy.api#documentation": "A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
The statements to combine with OR logic. You can use any statements that can be\n nested.
", - "smithy.api#required": {} + "smithy.api#enumValue": "HEADER_MATCH_PATTERN" } - } - }, - "traits": { - "smithy.api#documentation": "A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
Override the rule group evaluation result to count only.
\nThis option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.
\nDon't override the rule group evaluation result. This is the most common setting.
" + "smithy.api#enumValue": "MAP_MATCH_SCOPE" } - } - }, - "traits": { - "smithy.api#documentation": "The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
\nYou can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.
\nThe limit on requests per 5-minute period for a single originating IP address. If the\n statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.
If you define more than one Rule in a WebACL, WAF\n evaluates each request against the Rules in order based on the value of\n Priority. WAF processes rules with lower priority first. The priorities\n don't need to be consecutive, but they must all be different.
Instructs WAF to count the web request and allow it.
" + "smithy.api#documentation": "Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
" } }, "Captcha": { @@ -6972,6 +7684,7 @@ "Capacity": { "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The web ACL capacity units (WCUs) required for this rule group.
\nWhen you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
", "smithy.api#required": {} } @@ -7099,6 +7812,7 @@ "com.amazonaws.wafv2#RulePriority": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -7139,6 +7853,7 @@ "com.amazonaws.wafv2#SampleWeight": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -7157,6 +7872,7 @@ "Weight": { "target": "com.amazonaws.wafv2#SampleWeight", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A value that indicates how one result in the response relates proportionally to other\n results in the response. For example, a result that has a weight of 2\n represents roughly twice as many web requests as a result that has a weight of\n 1.
The size, in byte, to compare to the request part, after any transformations.
", "smithy.api#required": {} } @@ -7333,10 +8055,7 @@ } }, "com.amazonaws.wafv2#SolveTimestamp": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.wafv2#SqliMatchStatement": { "type": "structure", @@ -7444,7 +8163,7 @@ "ManagedRuleGroupStatement": { "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", "traits": { - "smithy.api#documentation": "A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
Sets the relative processing order for multiple transformations that are defined for a\n rule statement. WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.
", "smithy.api#required": {} } @@ -7637,100 +8357,141 @@ "com.amazonaws.wafv2#TextTransformationPriority": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.wafv2#TextTransformationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "COMPRESS_WHITE_SPACE", - "name": "COMPRESS_WHITE_SPACE" - }, - { - "value": "HTML_ENTITY_DECODE", - "name": "HTML_ENTITY_DECODE" - }, - { - "value": "LOWERCASE", - "name": "LOWERCASE" - }, - { - "value": "CMD_LINE", - "name": "CMD_LINE" - }, - { - "value": "URL_DECODE", - "name": "URL_DECODE" - }, - { - "value": "BASE64_DECODE", - "name": "BASE64_DECODE" - }, - { - "value": "HEX_DECODE", - "name": "HEX_DECODE" - }, - { - "value": "MD5", - "name": "MD5" - }, - { - "value": "REPLACE_COMMENTS", - "name": "REPLACE_COMMENTS" - }, - { - "value": "ESCAPE_SEQ_DECODE", - "name": "ESCAPE_SEQ_DECODE" - }, - { - "value": "SQL_HEX_DECODE", - "name": "SQL_HEX_DECODE" - }, - { - "value": "CSS_DECODE", - "name": "CSS_DECODE" - }, - { - "value": "JS_DECODE", - "name": "JS_DECODE" - }, - { - "value": "NORMALIZE_PATH", - "name": "NORMALIZE_PATH" - }, - { - "value": "NORMALIZE_PATH_WIN", - "name": "NORMALIZE_PATH_WIN" - }, - { - "value": "REMOVE_NULLS", - "name": "REMOVE_NULLS" - }, - { - "value": "REPLACE_NULLS", - "name": "REPLACE_NULLS" - }, - { - "value": "BASE64_DECODE_EXT", - "name": "BASE64_DECODE_EXT" - }, - { - "value": "URL_DECODE_UNI", - "name": "URL_DECODE_UNI" - }, - { - "value": "UTF8_TO_UNICODE", - "name": "UTF8_TO_UNICODE" - } - ] + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "COMPRESS_WHITE_SPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPRESS_WHITE_SPACE" + } + }, + "HTML_ENTITY_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTML_ENTITY_DECODE" + } + }, + "LOWERCASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOWERCASE" + } + }, + "CMD_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMD_LINE" + } + }, + "URL_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL_DECODE" + } + }, + "BASE64_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64_DECODE" + } + }, + "HEX_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEX_DECODE" + } + }, + "MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD5" + } + }, + "REPLACE_COMMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_COMMENTS" + } + }, + "ESCAPE_SEQ_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ESCAPE_SEQ_DECODE" + } + }, + "SQL_HEX_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_HEX_DECODE" + } + }, + "CSS_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSS_DECODE" + } + }, + "JS_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JS_DECODE" + } + }, + "NORMALIZE_PATH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZE_PATH" + } + }, + "NORMALIZE_PATH_WIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZE_PATH_WIN" + } + }, + "REMOVE_NULLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_NULLS" + } + }, + "REPLACE_NULLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_NULLS" + } + }, + "BASE64_DECODE_EXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64_DECODE_EXT" + } + }, + "URL_DECODE_UNI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL_DECODE_UNI" + } + }, + "UTF8_TO_UNICODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTF8_TO_UNICODE" + } + } } }, "com.amazonaws.wafv2#TextTransformations": { @@ -7769,7 +8530,6 @@ "com.amazonaws.wafv2#TimeWindowDay": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -7778,7 +8538,6 @@ "com.amazonaws.wafv2#TimeWindowSecond": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 259200 @@ -7914,7 +8673,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExample address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
A boolean indicating whether WAF should store a sampling of the web requests that\n match the rules. You can view the sampled requests through the WAF console.
", "smithy.api#required": {} } @@ -8458,6 +9218,7 @@ "CloudWatchMetricsEnabled": { "target": "com.amazonaws.wafv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the\n list of available metrics, see WAF\n Metrics.
", "smithy.api#required": {} } @@ -8632,7 +9393,7 @@ } }, "traits": { - "smithy.api#documentation": "WAF couldn’t perform the operation because your resource doesn’t exist.
", + "smithy.api#documentation": "WAF couldn’t perform the operation because your resource doesn't exist. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate.
", "smithy.api#error": "client" } }, @@ -8704,7 +9465,7 @@ } }, "traits": { - "smithy.api#documentation": "WAF couldn’t retrieve a resource that you specified for this operation. Verify the\n resources that you are specifying in your request parameters and then retry the\n operation.
", + "smithy.api#documentation": "WAF couldn’t retrieve a resource that you specified for this operation. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate. Verify the resources that you are specifying in your request \n parameters and then retry the operation.
", "smithy.api#error": "client" } }, @@ -8761,6 +9522,7 @@ "Capacity": { "target": "com.amazonaws.wafv2#ConsumedCapacity", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The web ACL capacity units (WCUs) currently being used by this web ACL.
\nWAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.
" } }, @@ -8779,6 +9541,7 @@ "ManagedByFirewallManager": { "target": "com.amazonaws.wafv2#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL.
" } }, diff --git a/codegen/sdk/aws-models/workspaces.json b/codegen/sdk/aws-models/workspaces.json index ba507e06cc2..2cf085fb3ec 100644 --- a/codegen/sdk/aws-models/workspaces.json +++ b/codegen/sdk/aws-models/workspaces.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -48,18 +48,20 @@ } }, "com.amazonaws.workspaces#AccessPropertyValue": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALLOW", - "name": "ALLOW" - }, - { - "value": "DENY", - "name": "DENY" + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" } - ] + } } }, "com.amazonaws.workspaces#AccountModification": { @@ -146,18 +148,20 @@ } }, "com.amazonaws.workspaces#Application": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Microsoft_Office_2016", - "name": "Microsoft_Office_2016" - }, - { - "value": "Microsoft_Office_2019", - "name": "Microsoft_Office_2019" + "type": "enum", + "members": { + "Microsoft_Office_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microsoft_Office_2016" } - ] + }, + "Microsoft_Office_2019": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microsoft_Office_2019" + } + } } }, "com.amazonaws.workspaces#ApplicationList": { @@ -290,30 +294,38 @@ "members": {} }, "com.amazonaws.workspaces#AssociationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_ASSOCIATED", - "name": "NOT_ASSOCIATED" - }, - { - "value": "ASSOCIATED_WITH_OWNER_ACCOUNT", - "name": "ASSOCIATED_WITH_OWNER_ACCOUNT" - }, - { - "value": "ASSOCIATED_WITH_SHARED_ACCOUNT", - "name": "ASSOCIATED_WITH_SHARED_ACCOUNT" - }, - { - "value": "PENDING_ASSOCIATION", - "name": "PENDING_ASSOCIATION" - }, - { - "value": "PENDING_DISASSOCIATION", - "name": "PENDING_DISASSOCIATION" - } - ] + "type": "enum", + "members": { + "NOT_ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_ASSOCIATED" + } + }, + "ASSOCIATED_WITH_OWNER_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_WITH_OWNER_ACCOUNT" + } + }, + "ASSOCIATED_WITH_SHARED_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_WITH_SHARED_ACCOUNT" + } + }, + "PENDING_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ASSOCIATION" + } + }, + "PENDING_DISASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DISASSOCIATION" + } + } } }, "com.amazonaws.workspaces#AuthorizeIpRules": { @@ -375,10 +387,7 @@ } }, "com.amazonaws.workspaces#BooleanObject": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.workspaces#BundleId": { "type": "string", @@ -408,34 +417,44 @@ "type": "string" }, "com.amazonaws.workspaces#ClientDeviceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DeviceTypeWindows", - "name": "DEVICE_TYPE_WINDOWS" - }, - { - "value": "DeviceTypeOsx", - "name": "DEVICE_TYPE_OSX" - }, - { - "value": "DeviceTypeAndroid", - "name": "DEVICE_TYPE_ANDROID" - }, - { - "value": "DeviceTypeIos", - "name": "DEVICE_TYPE_IOS" - }, - { - "value": "DeviceTypeLinux", - "name": "DEVICE_TYPE_LINUX" - }, - { - "value": "DeviceTypeWeb", - "name": "DEVICE_TYPE_WEB" - } - ] + "type": "enum", + "members": { + "DEVICE_TYPE_WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeviceTypeWindows" + } + }, + "DEVICE_TYPE_OSX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeviceTypeOsx" + } + }, + "DEVICE_TYPE_ANDROID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeviceTypeAndroid" + } + }, + "DEVICE_TYPE_IOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeviceTypeIos" + } + }, + "DEVICE_TYPE_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeviceTypeLinux" + } + }, + "DEVICE_TYPE_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeviceTypeWeb" + } + } } }, "com.amazonaws.workspaces#ClientDeviceTypeList": { @@ -488,6 +507,12 @@ "traits": { "smithy.api#documentation": "Specifies whether users can cache their credentials on the Amazon WorkSpaces client.\n When enabled, users can choose to reconnect to their WorkSpaces without re-entering their\n credentials.
" } + }, + "LogUploadEnabled": { + "target": "com.amazonaws.workspaces#LogUploadEnum", + "traits": { + "smithy.api#documentation": "Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to \n WorkSpaces to troubleshoot issues when using the WorkSpaces client. \n When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all \n users in the specified directory.
" + } } }, "traits": { @@ -531,46 +556,62 @@ } }, "com.amazonaws.workspaces#Compute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALUE", - "name": "VALUE" - }, - { - "value": "STANDARD", - "name": "STANDARD" - }, - { - "value": "PERFORMANCE", - "name": "PERFORMANCE" - }, - { - "value": "POWER", - "name": "POWER" - }, - { - "value": "GRAPHICS", - "name": "GRAPHICS" - }, - { - "value": "POWERPRO", - "name": "POWERPRO" - }, - { - "value": "GRAPHICSPRO", - "name": "GRAPHICSPRO" - }, - { - "value": "GRAPHICS_G4DN", - "name": "GRAPHICS_G4DN" - }, - { - "value": "GRAPHICSPRO_G4DN", - "name": "GRAPHICSPRO_G4DN" - } - ] + "type": "enum", + "members": { + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "PERFORMANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERFORMANCE" + } + }, + "POWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POWER" + } + }, + "GRAPHICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAPHICS" + } + }, + "POWERPRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POWERPRO" + } + }, + "GRAPHICSPRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAPHICSPRO" + } + }, + "GRAPHICS_G4DN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAPHICS_G4DN" + } + }, + "GRAPHICSPRO_G4DN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAPHICSPRO_G4DN" + } + } } }, "com.amazonaws.workspaces#ComputeType": { @@ -779,22 +820,26 @@ } }, "com.amazonaws.workspaces#ConnectionAliasState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.workspaces#ConnectionIdentifier": { @@ -808,22 +853,26 @@ } }, "com.amazonaws.workspaces#ConnectionState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONNECTED", - "name": "CONNECTED" - }, - { - "value": "DISCONNECTED", - "name": "DISCONNECTED" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" } - ] + }, + "DISCONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCONNECTED" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } } }, "com.amazonaws.workspaces#ConnectionString": { @@ -1443,7 +1492,7 @@ "OwnerAccountId": { "target": "com.amazonaws.workspaces#AwsAccount", "traits": { - "smithy.api#documentation": "The identifier of the AWS account that owns the image.
" + "smithy.api#documentation": "The identifier of the Amazon Web Services account that owns the image.
" } } } @@ -1510,48 +1559,54 @@ } }, "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.workspaces#DedicatedTenancySupportEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" } - ] + } } }, "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + } } }, "com.amazonaws.workspaces#DefaultClientBrandingAttributes": { @@ -1693,18 +1748,20 @@ } }, "com.amazonaws.workspaces#DeletableSamlProperty": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SAML_PROPERTIES_USER_ACCESS_URL", - "name": "SAML_PROPERTIES_USER_ACCESS_URL" - }, - { - "value": "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME", - "name": "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME" + "type": "enum", + "members": { + "SAML_PROPERTIES_USER_ACCESS_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAML_PROPERTIES_USER_ACCESS_URL" + } + }, + "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME" } - ] + } } }, "com.amazonaws.workspaces#DeleteClientBranding": { @@ -3270,18 +3327,20 @@ } }, "com.amazonaws.workspaces#ImageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OWNED", - "name": "OWNED" - }, - { - "value": "SHARED", - "name": "SHARED" + "type": "enum", + "members": { + "OWNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OWNED" } - ] + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } } }, "com.amazonaws.workspaces#ImportClientBranding": { @@ -3703,7 +3762,6 @@ "com.amazonaws.workspaces#Limit": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 25 @@ -3771,6 +3829,23 @@ } } }, + "com.amazonaws.workspaces#LogUploadEnum": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.workspaces#LoginMessage": { "type": "map", "key": { @@ -3789,7 +3864,6 @@ "com.amazonaws.workspaces#ManagementCidrRangeMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 5 @@ -3865,22 +3939,26 @@ } }, "com.amazonaws.workspaces#ModificationResourceEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ROOT_VOLUME", - "name": "ROOT_VOLUME" - }, - { - "value": "USER_VOLUME", - "name": "USER_VOLUME" - }, - { - "value": "COMPUTE_TYPE", - "name": "COMPUTE_TYPE" + "type": "enum", + "members": { + "ROOT_VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOT_VOLUME" + } + }, + "USER_VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_VOLUME" + } + }, + "COMPUTE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTE_TYPE" } - ] + } } }, "com.amazonaws.workspaces#ModificationState": { @@ -3904,18 +3982,20 @@ } }, "com.amazonaws.workspaces#ModificationStateEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UPDATE_INITIATED", - "name": "UPDATE_INITIATED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" + "type": "enum", + "members": { + "UPDATE_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_INITIATED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } - ] + } } }, "com.amazonaws.workspaces#ModificationStateList": { @@ -4339,18 +4419,20 @@ } }, "com.amazonaws.workspaces#OperatingSystemType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "WINDOWS" - }, - { - "value": "LINUX", - "name": "LINUX" + "type": "enum", + "members": { + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + }, + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" } - ] + } } }, "com.amazonaws.workspaces#OperationInProgressException": { @@ -4520,18 +4602,20 @@ } }, "com.amazonaws.workspaces#ReconnectEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + } } }, "com.amazonaws.workspaces#Region": { @@ -4846,31 +4930,27 @@ } }, "com.amazonaws.workspaces#RootVolumeSizeGib": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.workspaces#RunningMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTO_STOP", - "name": "AUTO_STOP" - }, - { - "value": "ALWAYS_ON", - "name": "ALWAYS_ON" + "type": "enum", + "members": { + "AUTO_STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_STOP" } - ] + }, + "ALWAYS_ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_ON" + } + } } }, "com.amazonaws.workspaces#RunningModeAutoStopTimeoutInMinutes": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.workspaces#SamlProperties": { "type": "structure", @@ -4899,22 +4979,26 @@ } }, "com.amazonaws.workspaces#SamlStatusEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK", - "name": "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK" } - ] + } } }, "com.amazonaws.workspaces#SamlUserAccessUrl": { @@ -5191,33 +5275,37 @@ } }, "com.amazonaws.workspaces#TargetWorkspaceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "ADMIN_MAINTENANCE", - "name": "ADMIN_MAINTENANCE" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "ADMIN_MAINTENANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_MAINTENANCE" + } + } } }, "com.amazonaws.workspaces#Tenancy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEDICATED", - "name": "DEDICATED" - }, - { - "value": "SHARED", - "name": "SHARED" + "type": "enum", + "members": { + "DEDICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEDICATED" } - ] + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } } }, "com.amazonaws.workspaces#TerminateRequest": { @@ -5637,10 +5725,7 @@ } }, "com.amazonaws.workspaces#UserVolumeSizeGib": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.workspaces#VolumeEncryptionKey": { "type": "string" @@ -6080,45 +6165,55 @@ } }, "com.amazonaws.workspaces#WorkspaceDirectoryState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REGISTERING", - "name": "REGISTERING" - }, - { - "value": "REGISTERED", - "name": "REGISTERED" - }, - { - "value": "DEREGISTERING", - "name": "DEREGISTERING" - }, - { - "value": "DEREGISTERED", - "name": "DEREGISTERED" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] + "type": "enum", + "members": { + "REGISTERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERING" + } + }, + "REGISTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERED" + } + }, + "DEREGISTERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEREGISTERING" + } + }, + "DEREGISTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEREGISTERED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.workspaces#WorkspaceDirectoryType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SIMPLE_AD", - "name": "SIMPLE_AD" - }, - { - "value": "AD_CONNECTOR", - "name": "AD_CONNECTOR" + "type": "enum", + "members": { + "SIMPLE_AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIMPLE_AD" + } + }, + "AD_CONNECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD_CONNECTOR" } - ] + } } }, "com.amazonaws.workspaces#WorkspaceErrorCode": { @@ -6248,30 +6343,38 @@ } }, "com.amazonaws.workspaces#WorkspaceImageIngestionProcess": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BYOL_REGULAR", - "name": "BYOL_REGULAR" - }, - { - "value": "BYOL_GRAPHICS", - "name": "BYOL_GRAPHICS" - }, - { - "value": "BYOL_GRAPHICSPRO", - "name": "BYOL_GRAPHICSPRO" - }, - { - "value": "BYOL_GRAPHICS_G4DN", - "name": "BYOL_GRAPHICS_G4DN" - }, - { - "value": "BYOL_REGULAR_WSP", - "name": "BYOL_REGULAR_WSP" - } - ] + "type": "enum", + "members": { + "BYOL_REGULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYOL_REGULAR" + } + }, + "BYOL_GRAPHICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYOL_GRAPHICS" + } + }, + "BYOL_GRAPHICSPRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYOL_GRAPHICSPRO" + } + }, + "BYOL_GRAPHICS_G4DN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYOL_GRAPHICS_G4DN" + } + }, + "BYOL_REGULAR_WSP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYOL_REGULAR_WSP" + } + } } }, "com.amazonaws.workspaces#WorkspaceImageList": { @@ -6291,37 +6394,43 @@ } }, "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "DEDICATED", - "name": "DEDICATED" + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "DEDICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEDICATED" } - ] + } } }, "com.amazonaws.workspaces#WorkspaceImageState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "ERROR", - "name": "ERROR" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.workspaces#WorkspaceList": { @@ -6440,78 +6549,110 @@ } }, "com.amazonaws.workspaces#WorkspaceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "IMPAIRED", - "name": "IMPAIRED" - }, - { - "value": "UNHEALTHY", - "name": "UNHEALTHY" - }, - { - "value": "REBOOTING", - "name": "REBOOTING" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "REBUILDING", - "name": "REBUILDING" - }, - { - "value": "RESTORING", - "name": "RESTORING" - }, - { - "value": "MAINTENANCE", - "name": "MAINTENANCE" - }, - { - "value": "ADMIN_MAINTENANCE", - "name": "ADMIN_MAINTENANCE" - }, - { - "value": "TERMINATING", - "name": "TERMINATING" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - }, - { - "value": "SUSPENDED", - "name": "SUSPENDED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + }, + "REBOOTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REBOOTING" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "REBUILDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REBUILDING" + } + }, + "RESTORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTORING" + } + }, + "MAINTENANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAINTENANCE" + } + }, + "ADMIN_MAINTENANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_MAINTENANCE" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.workspaces#WorkspacesDefaultRoleNotFoundException": { @@ -6566,24 +6707,6 @@ }, "com.amazonaws.workspaces#WorkspacesService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "WorkSpaces", - "arnNamespace": "workspaces", - "cloudFormationName": "WorkSpaces", - "cloudTrailEventSource": "workspaces.amazonaws.com", - "endpointPrefix": "workspaces" - }, - "aws.auth#sigv4": { - "name": "workspaces" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows\n or Amazon Linux desktops for your users, known as WorkSpaces.\n WorkSpaces eliminates the need to procure and deploy hardware or install complex\n software. You can quickly add or remove users as your needs change. Users can access their\n virtual desktops from multiple devices or web browsers.
\nThis API Reference provides detailed information about the actions, data types,\n parameters, and errors of the WorkSpaces service. For more information about the\n supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services\n General Reference.
\nYou can also manage your WorkSpaces resources using the WorkSpaces\n console, Command Line Interface (CLI), and SDKs. For more information about\n administering WorkSpaces, see the Amazon WorkSpaces Administration Guide.\n For more information about using the Amazon WorkSpaces client application or web\n browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more\n information about using the CLI to manage your WorkSpaces resources,\n see the WorkSpaces section of the CLI Reference.
", - "smithy.api#title": "Amazon WorkSpaces", - "smithy.api#xmlNamespace": { - "uri": "http://workspaces.amazonaws.com/api/v1" - } - }, "version": "2015-04-08", "operations": [ { @@ -6775,7 +6898,25 @@ { "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermission" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "WorkSpaces", + "arnNamespace": "workspaces", + "cloudFormationName": "WorkSpaces", + "cloudTrailEventSource": "workspaces.amazonaws.com", + "endpointPrefix": "workspaces" + }, + "aws.auth#sigv4": { + "name": "workspaces" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows\n or Amazon Linux desktops for your users, known as WorkSpaces.\n WorkSpaces eliminates the need to procure and deploy hardware or install complex\n software. You can quickly add or remove users as your needs change. Users can access their\n virtual desktops from multiple devices or web browsers.
\nThis API Reference provides detailed information about the actions, data types,\n parameters, and errors of the WorkSpaces service. For more information about the\n supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services\n General Reference.
\nYou can also manage your WorkSpaces resources using the WorkSpaces\n console, Command Line Interface (CLI), and SDKs. For more information about\n administering WorkSpaces, see the Amazon WorkSpaces Administration Guide.\n For more information about using the Amazon WorkSpaces client application or web\n browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more\n information about using the CLI to manage your WorkSpaces resources,\n see the WorkSpaces section of the CLI Reference.
", + "smithy.api#title": "Amazon WorkSpaces", + "smithy.api#xmlNamespace": { + "uri": "http://workspaces.amazonaws.com/api/v1" + } + } } } } diff --git a/gradle.properties b/gradle.properties index 95d961c3162..afd35728b9e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.17.7-SNAPSHOT smithyVersion=1.23.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.12.6 +smithyKotlinVersion=0.12.7 # kotlin kotlinVersion=1.7.10 @@ -39,4 +39,4 @@ slf4jVersion=1.7.36 # dokka config (values specified at build-time as needed) smithyKotlinPackageListUrl= -smithyKotlinDocBaseUrl=https://docs.aws.amazon.com/sdk-for-kotlin/latest/reference/smithy-kotlin \ No newline at end of file +smithyKotlinDocBaseUrl=https://docs.aws.amazon.com/sdk-for-kotlin/latest/reference/smithy-kotlin